Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Pay Period API
11 actions
11 updates
phrasing
extends
openapi/deputy-payperiod-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/resource/PayPeriod'].get
$.paths['/resource/PayPeriod/INFO'].get
$.paths['/resource/PayPeriod/PREDICT'].post
$.paths['/resource/PayPeriod/QUERY'].post
$.paths['/resource/PayPeriod/{id}'].get
$.paths['/resource/PayPeriod/{id}/COMMENTS'].get
$.paths['/resource/PayPeriod/{id}/COMMENTS'].post
$.paths['/resource/PayPeriod/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/PayPeriod/{id}/HISTORY'].get
$.paths['/resource/PayPeriod/{id}/HISTORY/travel/{timestamp}'].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 Deputy V1 Resource Pay Period API
version: 1.0.0
extends: openapi/deputy-payperiod-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/PayPeriod'].get
update:
x-apievangelist-phrasing:
intent: List pay periods
effect: read
questions:
- Which pay periods exist in Deputy?
- Can I get every pay period record?
instructions:
- text: List all pay periods.
- text: Show every pay period record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/PayPeriod/INFO'].get
update:
x-apievangelist-phrasing:
intent: Describe the PayPeriod resource
effect: read
questions:
- What fields and associations does a pay period have?
- Which pay period fields can I query?
instructions:
- text: Describe the PayPeriod resource.
- text: Show the field metadata for pay periods.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/PayPeriod/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing pay period by its details
effect: read
questions:
- Can I find the existing pay period that matches a name and start date?
- What does a pay period prediction return?
instructions:
- text: Predict the existing pay period named {Name} with cycle {Cycle} starting {StartDate}.
slots:
Name: requestBody.Name
Cycle: requestBody.Cycle
StartDate: requestBody.StartDate
- text: Find the pay period matching {Name}, {Cycle}, {StartDate} and {Id}.
slots:
Name: requestBody.Name
Cycle: requestBody.Cycle
StartDate: requestBody.StartDate
Id: requestBody.Id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/PayPeriod/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search pay periods
effect: read
questions:
- How do I find pay periods by name or cycle?
- Can I sort and page through pay periods?
instructions:
- text: Search pay periods matching {search}.
slots:
search: requestBody.search
- text: Find pay periods matching {search} sorted by {sort}, {max} at a time.
slots:
search: requestBody.search
sort: requestBody.sort
max: requestBody.max
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/PayPeriod/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a pay period
effect: read
questions:
- What are the details of one pay period?
- Can I fetch a pay period by its id?
instructions:
- text: Get pay period {id}.
slots:
id: path.id
- text: Show the details of pay period {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/PayPeriod/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a pay period
effect: read
questions:
- What comments have been left on a pay period?
- Can I see the comment history for one pay period?
instructions:
- text: List comments on pay period {id}.
slots:
id: path.id
- text: Show the comment history of pay period {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/PayPeriod/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a pay period
effect: write
questions:
- Can I add a comment to a pay period?
- How do I annotate a pay period with a note?
instructions:
- text: Comment {Comment} on pay period {id}.
slots:
Comment: requestBody.Comment
id: path.id
- text: Add a note {Comment} to pay period {id}.
slots:
Comment: requestBody.Comment
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/PayPeriod/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a pay period
effect: destructive
questions:
- Can I remove a comment from a pay period?
- What happens to a pay period comment I delete?
instructions:
- text: Delete comment {commentId} from pay period {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the comment {commentId} on pay period {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/PayPeriod/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get a pay period's change history
effect: read
questions:
- Who changed a pay period and when?
- Can I see the full change history of a pay period?
instructions:
- text: Show the change history of pay period {id}.
slots:
id: path.id
- text: List every change made to pay period {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/PayPeriod/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: View a pay period as it was at a past time
effect: read
questions:
- What did a pay period look like at a specific moment in the past?
- Can I travel back to a pay period's state at a given timestamp?
instructions:
- text: Show pay period {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel to pay period {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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-payperiod-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.