Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Employee Agreement API

17 actions 17 updates phrasing extends openapi/deputy-employeeagreement-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 17 · first 16 shown; the file carries all of them

$.info
$.paths['/resource/EmployeeAgreement'].get
$.paths['/resource/EmployeeAgreement'].put
$.paths['/resource/EmployeeAgreement'].post
$.paths['/resource/EmployeeAgreement/BULK'].post
$.paths['/resource/EmployeeAgreement/INFO'].get
$.paths['/resource/EmployeeAgreement/PREDICT'].post
$.paths['/resource/EmployeeAgreement/QUERY'].post
$.paths['/resource/EmployeeAgreement/{id}'].get
$.paths['/resource/EmployeeAgreement/{id}'].put
$.paths['/resource/EmployeeAgreement/{id}'].post
$.paths['/resource/EmployeeAgreement/{id}'].delete
$.paths['/resource/EmployeeAgreement/{id}/COMMENTS'].get
$.paths['/resource/EmployeeAgreement/{id}/COMMENTS'].post
$.paths['/resource/EmployeeAgreement/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmployeeAgreement/{id}/HISTORY'].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 API
  version: 1.0.0
extends: openapi/deputy-employeeagreement-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: 16
- target: $.paths['/resource/EmployeeAgreement'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee agreements
      effect: read
      questions:
      - Which employee agreements do I have access to?
      - Can I page through all employee agreements?
      instructions:
      - text: List all my employee agreements.
      - text: Show every employee agreement record I can see.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an employee agreement
      effect: write
      questions:
      - How do I overwrite an employee agreement record with a PUT request?
      - Can I set the salary pay rule and base rate when replacing an agreement?
      instructions:
      - text: Replace employee agreement {id} with employee {employee}, pay point {pay_point}, pay period {pay_period}, start {start_date}, active {active}, modified {modified}.
        slots:
          id: requestBody.Id
          employee: requestBody.EmployeeId
          pay_point: requestBody.PayPoint
          pay_period: requestBody.PayPeriod
          start_date: requestBody.StartDate
          active: requestBody.Active
          modified: requestBody.Modified
      - text: Overwrite agreement {id} for employee {employee} on pay point {pay_point} with pay period {pay_period}, start {start_date}, active {active}, modified {modified}.
        slots:
          id: requestBody.Id
          employee: requestBody.EmployeeId
          pay_point: requestBody.PayPoint
          pay_period: requestBody.PayPeriod
          start_date: requestBody.StartDate
          active: requestBody.Active
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an employee agreement
      effect: write
      questions:
      - How do I create a new employee agreement record?
      - What fields are required to create an agreement?
      instructions:
      - text: Create employee agreement {id} for employee {employee}, pay point {pay_point}, pay period {pay_period}, start {start_date}, active {active}, modified {modified}.
        slots:
          id: requestBody.Id
          employee: requestBody.EmployeeId
          pay_point: requestBody.PayPoint
          pay_period: requestBody.PayPeriod
          start_date: requestBody.StartDate
          active: requestBody.Active
          modified: requestBody.Modified
      - text: Add a new agreement {id} for employee {employee} on pay point {pay_point} with pay period {pay_period}, start {start_date}, active {active}, modified {modified}.
        slots:
          id: requestBody.Id
          employee: requestBody.EmployeeId
          pay_point: requestBody.PayPoint
          pay_period: requestBody.PayPeriod
          start_date: requestBody.StartDate
          active: requestBody.Active
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many employee agreements
      effect: write
      questions:
      - Can I create or update several employee agreements in one request?
      - How do I bulk upsert employee agreements?
      instructions:
      - text: Bulk create or update these employee agreements.
      - text: Upsert this batch of employee agreements.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employee agreement field metadata
      effect: read
      questions:
      - Which fields can I query on employee agreements?
      - What types and associations does the employee agreement resource have?
      instructions:
      - text: Show the field metadata for employee agreements.
      - text: List the queryable fields and associations of employee agreements.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing employee agreement
      effect: read
      questions:
      - How do I find an existing employee agreement before creating one?
      - Can I predict-match an agreement by employee, pay point and pay period?
      instructions:
      - text: Predict-match an agreement for employee {employee}, pay point {pay_point}, pay period {pay_period}, start {start_date}, active {active}, modified {modified}.
        slots:
          employee: requestBody.EmployeeId
          pay_point: requestBody.PayPoint
          pay_period: requestBody.PayPeriod
          start_date: requestBody.StartDate
          active: requestBody.Active
          modified: requestBody.Modified
      - text: Find the closest existing agreement for employee {employee} on pay point {pay_point} with pay period {pay_period}, start {start_date}, active {active}, modified {modified}.
        slots:
          employee: requestBody.EmployeeId
          pay_point: requestBody.PayPoint
          pay_period: requestBody.PayPeriod
          start_date: requestBody.StartDate
          active: requestBody.Active
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee agreements
      effect: read
      questions:
      - How do I find employee agreements by employee or pay point?
      - Can I sort and page employee agreement search results?
      instructions:
      - text: Search employee agreements matching {search}.
        slots:
          search: requestBody.search
      - text: Find employee agreements sorted by {sort}, {max} at a time.
        slots:
          sort: requestBody.sort
          max: requestBody.max
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee agreement
      effect: read
      questions:
      - How do I fetch one employee agreement by id?
      - What pay point and pay period does a specific agreement have?
      instructions:
      - text: Get employee agreement {id}.
        slots:
          id: path.id
      - text: Show the agreement record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace an employee agreement
      effect: write
      questions:
      - How do I set up an employee agreement with paypoint and pay period?
      - Can I extend or backdate an employee agreement?
      instructions:
      - text: Create employee agreement {id} for employee {EmployeeId} with paypoint {PayPoint}, pay period {PayPeriod} and type {EmpType}.
        slots:
          id: path.id
          EmployeeId: requestBody.EmployeeId
          PayPoint: requestBody.PayPoint
          PayPeriod: requestBody.PayPeriod
          EmpType: requestBody.EmpType
      - text: Set the effective date of agreement {id} to {EffectiveDate}.
        slots:
          id: path.id
          EffectiveDate: requestBody.EffectiveDate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an employee agreement
      effect: write
      questions:
      - How do I update an existing employee agreement with a POST?
      - Can I change the end date on an agreement I already have?
      instructions:
      - text: Update employee agreement {id} with employee {employee}, pay point {pay_point}, pay period {pay_period}, start {start_date}, active {active}, modified {modified}.
        slots:
          id: path.id
          employee: requestBody.EmployeeId
          pay_point: requestBody.PayPoint
          pay_period: requestBody.PayPeriod
          start_date: requestBody.StartDate
          active: requestBody.Active
          modified: requestBody.Modified
      - text: Change agreement {id} for employee {employee} on pay point {pay_point} with pay period {pay_period}, start {start_date}, active {active}, modified {modified}.
        slots:
          id: path.id
          employee: requestBody.EmployeeId
          pay_point: requestBody.PayPoint
          pay_period: requestBody.PayPeriod
          start_date: requestBody.StartDate
          active: requestBody.Active
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an employee agreement
      effect: destructive
      questions:
      - How do I delete an employee agreement?
      - Can I remove an agreement record by id?
      instructions:
      - text: Delete employee agreement {id}.
        slots:
          id: path.id
      - text: Remove agreement record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on an agreement
      effect: read
      questions:
      - What comments have been left on an employee agreement?
      - Can I read the comment history on an agreement?
      instructions:
      - text: List comments on employee agreement {id}.
        slots:
          id: path.id
      - text: Show the comment history of agreement {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on an agreement
      effect: write
      questions:
      - How do I add a comment to an employee agreement?
      - Can I leave a note on an agreement?
      instructions:
      - text: Add comment {comment} to employee agreement {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment {comment} on agreement {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on an agreement
      effect: destructive
      questions:
      - How do I remove a comment from an employee agreement?
      - Can I delete a single comment on an agreement?
      instructions:
      - text: Delete comment {comment_id} from employee agreement {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      - text: Remove comment {comment_id} on agreement {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agreement's change history
      effect: read
      questions:
      - What changes have been made to an employee agreement over time?
      - Can I see the full edit history of an agreement?
      instructions:
      - text: Show the change history of employee agreement {id}.
        slots:
          id: path.id
      - text: List every edit made to agreement {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreement/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: View an agreement at a past time
      effect: read
      questions:
      - How do I see what an agreement looked like at a specific past time?
      - Can I travel back to an agreement's state at a given timestamp?
      instructions:
      - text: Show employee agreement {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to agreement {id} at {timestamp} and show it.
        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-employeeagreement-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.