Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ATS Subpackage Scorecards API

3 actions 3 updates phrasing extends openapi/merge-subpackage-scorecards-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/scorecards'].get

$.paths['/ats/v1/scorecards/{id}'].get

OpenAPI Overlay

# 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 Scorecards API
  version: 1.0.0
extends: openapi/merge-subpackage-scorecards-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/scorecards'].get
  update:
    x-apievangelist-phrasing:
      intent: List interview scorecards
      effect: read
      questions:
      - What scorecards have interviewers submitted for an application?
      - Can I list scorecards written by one interviewer?
      instructions:
      - text: List scorecards for application {application_id}.
        slots:
          application_id: query.application_id
      - text: Show scorecards from interviewer {interviewer_id}.
        slots:
          interviewer_id: query.interviewer_id
      - text: List scorecards for interview {interview_id}.
        slots:
          interview_id: query.interview_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/scorecards/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an interview scorecard
      effect: read
      questions:
      - What did an interviewer record on a particular scorecard?
      - How do I retrieve one scorecard with its interview expanded?
      instructions:
      - text: Get scorecard {id}.
        slots:
          id: path.id
      - text: Fetch scorecard {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'