Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Employee History API
11 actions
11 updates
phrasing
extends
openapi/deputy-employeehistory-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/EmployeeHistory'].get
$.paths['/resource/EmployeeHistory/INFO'].get
$.paths['/resource/EmployeeHistory/PREDICT'].post
$.paths['/resource/EmployeeHistory/QUERY'].post
$.paths['/resource/EmployeeHistory/{id}'].get
$.paths['/resource/EmployeeHistory/{id}/COMMENTS'].get
$.paths['/resource/EmployeeHistory/{id}/COMMENTS'].post
$.paths['/resource/EmployeeHistory/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmployeeHistory/{id}/HISTORY'].get
$.paths['/resource/EmployeeHistory/{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 Employee History API
version: 1.0.0
extends: openapi/deputy-employeehistory-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/EmployeeHistory'].get
update:
x-apievangelist-phrasing:
intent: List employee history records
effect: read
questions:
- Which employee history records can I see?
- Can I page through employee history for a large table?
instructions:
- text: List employee history records.
- text: Show all employee history records.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeHistory/INFO'].get
update:
x-apievangelist-phrasing:
intent: Describe the employee history resource
effect: read
questions:
- Which fields and associations does employee history have?
- What types are the employee history fields?
instructions:
- text: Describe the employee history resource.
- text: Show the field metadata for employee history.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeHistory/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing employee history record
effect: read
questions:
- Can I find an existing employee history record from a name and role?
- What does the employee history prediction need to match?
instructions:
- text: Predict an employee history record for {FirstName} {LastName} at {Company} with role {Role}.
slots:
FirstName: requestBody.FirstName
LastName: requestBody.LastName
Company: requestBody.Company
Role: requestBody.Role
- text: Find the existing employee history record matching {FirstName} {LastName} ({Role}, active {Active}).
slots:
FirstName: requestBody.FirstName
LastName: requestBody.LastName
Role: requestBody.Role
Active: requestBody.Active
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeHistory/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search employee history records
effect: read
questions:
- Can I search employee history by name or role?
- How do I sort employee history search results?
instructions:
- text: Search employee history where {search}.
slots:
search: requestBody.search
- text: Find employee history matching {search} sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeHistory/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an employee history record
effect: read
questions:
- Can I fetch one employee history record by id?
- What does a single employee history record include?
instructions:
- text: Get employee history record {id}.
slots:
id: path.id
- text: Show the employee history for record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeHistory/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on an employee history record
effect: read
questions:
- What comments have been left on an employee history record?
- Can I read the comment thread on an employee history entry?
instructions:
- text: List comments on employee history record {id}.
slots:
id: path.id
- text: Show the comment thread for employee history {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeHistory/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on an employee history record
effect: write
questions:
- Can I add a comment to an employee history record?
- How do I annotate an employee history entry?
instructions:
- text: Comment {Comment} on employee history record {id}.
slots:
Comment: requestBody.Comment
id: path.id
- text: Add a note {Comment} to employee history {id}.
slots:
Comment: requestBody.Comment
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeHistory/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on an employee history record
effect: destructive
questions:
- Can I remove a comment from an employee history record?
- Is deleting an employee history comment permanent?
instructions:
- text: Delete comment {commentId} from employee history record {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the comment {commentId} on employee history {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeHistory/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history of an employee history record
effect: read
questions:
- Who changed an employee history record and when?
- Can I see the edit history of an employee history entry?
instructions:
- text: Show the change history of employee history record {id}.
slots:
id: path.id
- text: List edits made to employee history {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeHistory/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: Get employee history as it was at a past time
effect: read
questions:
- Can I see what an employee history record looked like at a past moment?
- How do I view employee history as it existed on a specific date?
instructions:
- text: Show employee history record {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Get employee history {id} as of {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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-employeehistory-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.