Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Employee Availability API
17 actions
17 updates
phrasing
extends
openapi/deputy-employeeavailability-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 17 · first 16 shown; the file carries all of them
$.info
$.paths['/resource/EmployeeAvailability'].get
$.paths['/resource/EmployeeAvailability'].put
$.paths['/resource/EmployeeAvailability'].post
$.paths['/resource/EmployeeAvailability/BULK'].post
$.paths['/resource/EmployeeAvailability/INFO'].get
$.paths['/resource/EmployeeAvailability/PREDICT'].post
$.paths['/resource/EmployeeAvailability/QUERY'].post
$.paths['/resource/EmployeeAvailability/{id}'].get
$.paths['/resource/EmployeeAvailability/{id}'].put
$.paths['/resource/EmployeeAvailability/{id}'].post
$.paths['/resource/EmployeeAvailability/{id}'].delete
$.paths['/resource/EmployeeAvailability/{id}/COMMENTS'].get
$.paths['/resource/EmployeeAvailability/{id}/COMMENTS'].post
$.paths['/resource/EmployeeAvailability/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmployeeAvailability/{id}/HISTORY'].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 Availability API
version: 1.0.0
extends: openapi/deputy-employeeavailability-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/EmployeeAvailability'].get
update:
x-apievangelist-phrasing:
intent: List employee availability records
effect: read
questions:
- Which days are my staff available to work?
- Can I see all employee availability records at once?
instructions:
- text: List all employee availability records.
- text: Show every staff availability entry.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability'].put
update:
x-apievangelist-phrasing:
intent: Create or replace an availability record
effect: write
questions:
- How do I create a new employee availability record?
- Can I overwrite an existing availability record in one call?
instructions:
- text: Create availability record {id} for {employee} on {date} with schedule {schedule}.
slots:
id: requestBody.Id
employee: requestBody.Employee
date: requestBody.Date
schedule: requestBody.Schedule
- text: Replace the existing availability record {id} for {employee} with schedule {schedule}.
slots:
id: requestBody.Id
employee: requestBody.Employee
schedule: requestBody.Schedule
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability'].post
update:
x-apievangelist-phrasing:
intent: Create an availability record
effect: write
questions:
- Can I add a single staff availability record for one day?
- What fields are required to create an availability record?
instructions:
- text: Create a new availability record for {employee} on {date} with schedule {schedule}.
slots:
employee: requestBody.Employee
date: requestBody.Date
schedule: requestBody.Schedule
- text: Add a one-day availability entry for {employee} on {date}.
slots:
employee: requestBody.Employee
date: requestBody.Date
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/BULK'].post
update:
x-apievangelist-phrasing:
intent: Create or update many availability records
effect: write
questions:
- Can I create or update several staff availability records in one request?
- How do I bulk load availability for many employees?
instructions:
- text: Bulk create or update these availability records.
- text: Process this array of staff availability entries in one call.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get availability field metadata
effect: read
questions:
- Which fields can I search on for employee availability?
- What data types and associations does the availability record have?
instructions:
- text: Get the field metadata for employee availability.
- text: Show which availability fields are queryable.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing availability record
effect: read
questions:
- Can I find the closest existing availability record for a partial payload?
- How do I upsert availability without creating duplicates?
instructions:
- text: Predict-match an existing availability record for {employee} on {date}.
slots:
employee: requestBody.Employee
date: requestBody.Date
- text: Find the existing availability record matching {employee} and {schedule}.
slots:
employee: requestBody.Employee
schedule: requestBody.Schedule
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search employee availability records
effect: read
questions:
- Which staff are available on a given date?
- Can I sort and page through availability records?
instructions:
- text: Search employee availability for {search}.
slots:
search: requestBody.search
- text: Find availability records matching {search}, sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an availability record
effect: read
questions:
- What are the details of one staff availability record?
- Can I fetch a single availability entry by id?
instructions:
- text: Get employee availability record {id}.
slots:
id: path.id
- text: Show the availability entry {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/{id}'].put
update:
x-apievangelist-phrasing:
intent: Replace an availability record
effect: write
questions:
- How do I overwrite an existing availability record?
- Can I fully replace an availability entry with new values?
instructions:
- text: Replace availability record {id} with {employee} on {date} and schedule {schedule}.
slots:
id: path.id
employee: requestBody.Employee
date: requestBody.Date
schedule: requestBody.Schedule
- text: Overwrite the full availability entry {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update an availability record
effect: write
questions:
- Can I partially update an existing availability record?
- How do I change just the comment on an availability entry?
instructions:
- text: Update availability record {id} with comment {comment}.
slots:
id: path.id
comment: requestBody.Comment
- text: Patch the existing availability entry {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an availability record
effect: destructive
questions:
- How do I remove a staff availability record?
- Can I delete an availability entry by id?
instructions:
- text: Delete employee availability record {id}.
slots:
id: path.id
- text: Remove the availability entry {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on an availability record
effect: read
questions:
- What comments have been left on a staff availability record?
- Can I see the notes on an availability entry?
instructions:
- text: List comments on availability record {id}.
slots:
id: path.id
- text: Show the notes on staff availability entry {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Add a comment to an availability record
effect: write
questions:
- How do I add a comment to a staff availability record?
- Can I annotate an availability entry with a note?
instructions:
- text: Add comment {comment} to availability record {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Annotate staff availability entry {id} with {comment}.
slots:
id: path.id
comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on an availability record
effect: destructive
questions:
- How do I remove a comment from a staff availability record?
- Can I delete a note on an availability entry?
instructions:
- text: Delete comment {commentId} from availability record {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the note {commentId} on staff availability entry {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history for an availability record
effect: read
questions:
- Who changed a staff availability record and when?
- Can I see the edit history of an availability entry?
instructions:
- text: Show the change history of availability record {id}.
slots:
id: path.id
- text: List edits made to staff availability entry {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAvailability/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: Get an availability record as it was at a past time
effect: read
questions:
- What did a staff availability record look like at a specific past moment?
- Can I see an availability entry as it existed before a change?
instructions:
- text: Show availability record {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Get staff availability entry {id} as it existed 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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-employeeavailability-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.