Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Leave Accrual API

17 actions 17 updates phrasing extends openapi/deputy-leaveaccrual-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/LeaveAccrual'].get
$.paths['/resource/LeaveAccrual'].put
$.paths['/resource/LeaveAccrual'].post
$.paths['/resource/LeaveAccrual/BULK'].post
$.paths['/resource/LeaveAccrual/INFO'].get
$.paths['/resource/LeaveAccrual/PREDICT'].post
$.paths['/resource/LeaveAccrual/QUERY'].post
$.paths['/resource/LeaveAccrual/{id}'].get
$.paths['/resource/LeaveAccrual/{id}'].put
$.paths['/resource/LeaveAccrual/{id}'].post
$.paths['/resource/LeaveAccrual/{id}'].delete
$.paths['/resource/LeaveAccrual/{id}/COMMENTS'].get
$.paths['/resource/LeaveAccrual/{id}/COMMENTS'].post
$.paths['/resource/LeaveAccrual/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/LeaveAccrual/{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 Leave Accrual API
  version: 1.0.0
extends: openapi/deputy-leaveaccrual-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/LeaveAccrual'].get
  update:
    x-apievangelist-phrasing:
      intent: List leave accrual records
      effect: read
      questions:
      - Which leave accrual records have been posted for employees?
      - Can I page through all leave accruals?
      instructions:
      - text: List all leave accrual records.
      - text: Show every leave accrual posted.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a leave accrual record
      effect: write
      questions:
      - How do I post a leave accrual for an employee?
      - Can I replace an accrual record by its ID?
      instructions:
      - text: Create leave accrual {id} for employee {employee} on {date} of type {type} under rule {rule} for {hours} hours and {days} days.
        slots:
          id: requestBody.Id
          employee: requestBody.Employee
          date: requestBody.TransactionDate
          type: requestBody.Type
          rule: requestBody.LeaveRule
          hours: requestBody.Hours
          days: requestBody.Days
      - text: Replace accrual {id} for {employee} with {hours} hours and {days} days.
        slots:
          id: requestBody.Id
          employee: requestBody.Employee
          hours: requestBody.Hours
          days: requestBody.Days
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual'].post
  update:
    x-apievangelist-phrasing:
      intent: Enter a leave accrual for an employee
      effect: write
      questions:
      - How do I record an employee's leave accrual from a leave rule?
      - Can I add hours and days for a leave accrual in a specific pay period?
      instructions:
      - text: Create a {Type} leave accrual for {Employee} on leave rule {LeaveRule} for {Days} days and {Hours} hours at {TransactionDate}.
        slots:
          Type: requestBody.Type
          Employee: requestBody.Employee
          LeaveRule: requestBody.LeaveRule
          Days: requestBody.Days
          Hours: requestBody.Hours
          TransactionDate: requestBody.TransactionDate
      - text: Add a {Type} accrual for {Employee} on {LeaveRule} for {Hours} hours, date {TransactionDate}, comment {Comment}.
        slots:
          Type: requestBody.Type
          Employee: requestBody.Employee
          LeaveRule: requestBody.LeaveRule
          Hours: requestBody.Hours
          TransactionDate: requestBody.TransactionDate
          Comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create or update leave accruals
      effect: write
      questions:
      - Can I import many leave accruals in one request?
      - How are each record in a bulk leave accrual batch processed?
      instructions:
      - text: Bulk create or update these leave accruals.
      - text: Process this batch of leave accrual records.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get leave accrual field metadata
      effect: read
      questions:
      - Which fields and associations does a leave accrual record have?
      - What types are the fields on a leave accrual?
      instructions:
      - text: Get the field metadata for leave accrual.
      - text: Show which leave accrual fields are queryable.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Predict a matching leave accrual
      effect: read
      questions:
      - Can I find an existing leave accrual before creating one?
      - What record would a partial leave accrual payload match?
      instructions:
      - text: Predict the matching leave accrual for {id} on {date} for {employee} of type {type} under rule {rule} with {hours} hours and {days} days.
        slots:
          id: requestBody.Id
          date: requestBody.TransactionDate
          employee: requestBody.Employee
          type: requestBody.Type
          rule: requestBody.LeaveRule
          hours: requestBody.Hours
          days: requestBody.Days
      - text: Find the existing accrual that matches {employee} on {date}.
        slots:
          employee: requestBody.Employee
          date: requestBody.TransactionDate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search leave accrual records
      effect: read
      questions:
      - Can I search leave accruals by employee or date?
      - How do I sort and page through leave accruals?
      instructions:
      - text: Search leave accruals matching {search}.
        slots:
          search: requestBody.search
      - text: Find leave accruals sorted by {sort}, {start} to {max}.
        slots:
          sort: requestBody.sort
          start: requestBody.start
          max: requestBody.max
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a leave accrual record
      effect: read
      questions:
      - Can I fetch one leave accrual by its ID?
      - What does a single leave accrual record contain?
      instructions:
      - text: Get leave accrual {id}.
        slots:
          id: path.id
      - text: Show the leave accrual record with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a leave accrual record
      effect: write
      questions:
      - Can I overwrite a leave accrual record entirely?
      - What happens if I PUT a leave accrual with a new ID?
      instructions:
      - text: Replace leave accrual {id} for {employee} on {date} of type {type} under rule {rule} with {hours} hours and {days} days.
        slots:
          id: path.id
          employee: requestBody.Employee
          date: requestBody.TransactionDate
          type: requestBody.Type
          rule: requestBody.LeaveRule
          hours: requestBody.Hours
          days: requestBody.Days
      - text: Overwrite accrual {id} with {hours} hours and {days} days.
        slots:
          id: path.id
          hours: requestBody.Hours
          days: requestBody.Days
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing leave accrual
      effect: write
      questions:
      - Can I correct an accrual entered on the wrong date?
      - What do I send to change an existing leave accrual?
      instructions:
      - text: Update leave accrual {id} for {Employee} to {Type} on rule {LeaveRule} for {Days} days and {Hours} hours at {TransactionDate}.
        slots:
          id: path.id
          Employee: requestBody.Employee
          Type: requestBody.Type
          LeaveRule: requestBody.LeaveRule
          Days: requestBody.Days
          Hours: requestBody.Hours
          TransactionDate: requestBody.TransactionDate
      - text: Correct accrual {id} to {Type} with {Hours} hours, date {TransactionDate}, rule {LeaveRule}, comment {Comment}.
        slots:
          id: path.id
          Type: requestBody.Type
          Hours: requestBody.Hours
          TransactionDate: requestBody.TransactionDate
          LeaveRule: requestBody.LeaveRule
          Comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a leave accrual record
      effect: destructive
      questions:
      - Can I delete a leave accrual record?
      - What is the way to remove an accrual entry?
      instructions:
      - text: Delete leave accrual {id}.
        slots:
          id: path.id
      - text: Remove the accrual record with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a leave accrual
      effect: read
      questions:
      - What comments have been added to a leave accrual?
      - Can I see the comment history on an accrual?
      instructions:
      - text: List comments on leave accrual {id}.
        slots:
          id: path.id
      - text: Show the comment history for accrual {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a leave accrual
      effect: write
      questions:
      - Can I add a comment to a leave accrual?
      - How do I annotate an accrual record?
      instructions:
      - text: Add comment {comment} to leave accrual {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: 'Comment on accrual {id}: {comment}.'
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a leave accrual
      effect: destructive
      questions:
      - Can I remove a comment from a leave accrual?
      - What is the way to delete a comment on an accrual?
      instructions:
      - text: Delete comment {commentId} from leave accrual {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove comment {commentId} on accrual {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history for a leave accrual
      effect: read
      questions:
      - Who changed a leave accrual and when?
      - Can I see the full change history of an accrual?
      instructions:
      - text: Get the change history of leave accrual {id}.
        slots:
          id: path.id
      - text: Show every change made to accrual {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/LeaveAccrual/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a leave accrual as it was at a past time
      effect: read
      questions:
      - Can I see how a leave accrual looked at a specific past moment?
      - What did an accrual record contain at a given timestamp?
      instructions:
      - text: Get leave accrual {id} as it existed at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to accrual {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-leaveaccrual-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.