Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ATS Subpackage Activities API

5 actions 5 updates phrasing extends openapi/merge-subpackage-activities-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/activities'].get
$.paths['/ats/v1/activities'].post
$.paths['/ats/v1/activities/{id}'].get
$.paths['/ats/v1/activities/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 Activities API
  version: 1.0.0
extends: openapi/merge-subpackage-activities-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: 4
- target: $.paths['/ats/v1/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List recruiting activities
      effect: read
      questions:
      - Can I pull the notes, emails and other activity logged on candidates?
      - Which ATS activities were performed by a specific user?
      instructions:
      - text: List ATS activities by user {user_id}.
        slots:
          user_id: query.user_id
      - text: Show recruiting activities created after {created_after}.
        slots:
          created_after: query.created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/activities'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a recruiting activity
      effect: write
      questions:
      - How do I log a note or email against a candidate in the ATS?
      - Does creating an ATS activity require the acting user's ID?
      instructions:
      - text: Log activity {activity} as remote user {remote_user_id}.
        slots:
          activity: requestBody.model
          remote_user_id: requestBody.remote_user_id
      - text: Create ATS activity {activity} for user {remote_user_id} asynchronously {run_async}.
        slots:
          activity: requestBody.model
          remote_user_id: requestBody.remote_user_id
          run_async: query.run_async
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/activities/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recruiting activity
      effect: read
      questions:
      - Can I look up one ATS activity by its ID?
      - What's recorded on a single candidate activity?
      instructions:
      - text: Get activity {id}.
        slots:
          id: path.id
      - text: Show me ATS activity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/activities/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields required to log an activity
      effect: read
      questions:
      - Which fields are required to log an activity in this ATS?
      - What does the applicant tracking system accept when posting an activity?
      instructions:
      - text: Show activity creation fields for account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the create metadata for ATS activities.
      method: generated
      generated: '2026-09-26'