Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Employee Agreement History API

11 actions 11 updates phrasing extends openapi/deputy-employeeagreementhistory-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Deputy's API. It is a proposal applied on top of the contract, not a document Deputy publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/resource/EmployeeAgreementHistory'].get
$.paths['/resource/EmployeeAgreementHistory/INFO'].get
$.paths['/resource/EmployeeAgreementHistory/PREDICT'].post
$.paths['/resource/EmployeeAgreementHistory/QUERY'].post
$.paths['/resource/EmployeeAgreementHistory/{id}'].get
$.paths['/resource/EmployeeAgreementHistory/{id}/COMMENTS'].get
$.paths['/resource/EmployeeAgreementHistory/{id}/COMMENTS'].post
$.paths['/resource/EmployeeAgreementHistory/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmployeeAgreementHistory/{id}/HISTORY'].get
$.paths['/resource/EmployeeAgreementHistory/{id}/HISTORY/travel/{timestamp}'].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 Deputy V1 Resource Employee Agreement History API
  version: 1.0.0
extends: openapi/deputy-employeeagreementhistory-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-17'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/resource/EmployeeAgreementHistory'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee agreement history records
      effect: read
      questions:
      - Which employee agreement history records have been recorded?
      - How do I see past pay rate agreements for employees?
      instructions:
      - text: List employee agreement history records.
      - text: Show the agreement history for all employees.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementHistory/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employee agreement history field metadata
      effect: read
      questions:
      - Which fields can I query on employee agreement history?
      - What types and associations does employee agreement history have?
      instructions:
      - text: Get the field metadata for employee agreement history.
      - text: Show which employee agreement history fields are queryable.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementHistory/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing employee agreement history record
      effect: read
      questions:
      - How do I find the existing agreement history record for a pay point and employee type?
      - Can I match a new agreement history record against the existing ones?
      instructions:
      - text: Find the existing employee agreement history record for pay point {pay_point} and employee type {emp_type}.
        slots:
          pay_point: requestBody.PayPoint
          emp_type: requestBody.EmpType
      - text: Predict-match an agreement history record with pay point {pay_point}, employee type {emp_type}, active {active}, start date {start_date}, pay period {pay_period}, modified {modified}.
        slots:
          pay_point: requestBody.PayPoint
          emp_type: requestBody.EmpType
          active: requestBody.Active
          start_date: requestBody.StartDate
          pay_period: requestBody.PayPeriod
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementHistory/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee agreement history
      effect: read
      questions:
      - Can I search employee agreement history by pay point and employee type?
      - How do I sort and page through agreement history records?
      instructions:
      - text: Search employee agreement history for pay point {pay_point} and employee type {emp_type}.
        slots:
          pay_point: requestBody.search
          emp_type: requestBody.search
      - text: Find agreement history records sorted by {sort} with {max} per page.
        slots:
          sort: requestBody.sort
          max: requestBody.max
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementHistory/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee agreement history record
      effect: read
      questions:
      - What does a single employee agreement history record contain?
      - Can I fetch one agreement history record by id?
      instructions:
      - text: Get employee agreement history record {id}.
        slots:
          id: path.id
      - text: Show the agreement history for record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementHistory/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on employee agreement history
      effect: read
      questions:
      - Was there a comment on a specific employee agreement history record?
      - How do I read the notes left on an agreement history row?
      instructions:
      - text: List comments on employee agreement history {id}.
        slots:
          id: path.id
      - text: Show the notes against agreement history {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementHistory/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on an employee agreement history record
      effect: write
      questions:
      - How do I add a comment to an employee agreement history record?
      - Can I annotate an agreement history record with a note?
      instructions:
      - text: Add comment {comment} to employee agreement history record {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment {comment} on agreement history record {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementHistory/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on an employee agreement history record
      effect: destructive
      questions:
      - How do I remove a comment from an employee agreement history record?
      - Can I delete a comment on an agreement history record?
      instructions:
      - text: Delete comment {comment_id} from employee agreement history record {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      - text: Remove comment {comment_id} on agreement history record {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementHistory/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of an employee agreement history record
      effect: read
      questions:
      - What changes have been made to an employee agreement history record?
      - Can I see the change history of an agreement history record?
      instructions:
      - text: Get the change history of employee agreement history record {id}.
        slots:
          id: path.id
      - text: Show the edit history of agreement history record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementHistory/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee agreement history record as it was
      effect: read
      questions:
      - How did an employee agreement history record look at a past moment?
      - Can I see an agreement history record as it was at a stored timestamp?
      instructions:
      - text: Get employee agreement history {id} as it existed at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Go back to the agreement history {id} at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      method: generated
      generated: '2026-11-17'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-employeeagreementhistory-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.