Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Schedule API
17 actions
17 updates
phrasing
extends
openapi/deputy-schedule-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/Schedule'].get
$.paths['/resource/Schedule'].put
$.paths['/resource/Schedule'].post
$.paths['/resource/Schedule/BULK'].post
$.paths['/resource/Schedule/INFO'].get
$.paths['/resource/Schedule/PREDICT'].post
$.paths['/resource/Schedule/QUERY'].post
$.paths['/resource/Schedule/{id}'].get
$.paths['/resource/Schedule/{id}'].put
$.paths['/resource/Schedule/{id}'].post
$.paths['/resource/Schedule/{id}'].delete
$.paths['/resource/Schedule/{id}/COMMENTS'].get
$.paths['/resource/Schedule/{id}/COMMENTS'].post
$.paths['/resource/Schedule/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Schedule/{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 Schedule API
version: 1.0.0
extends: openapi/deputy-schedule-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/Schedule'].get
update:
x-apievangelist-phrasing:
intent: List schedule records
effect: read
questions:
- Which recurring shift schedules exist in Deputy?
- Can I page through all schedule records?
instructions:
- text: List all schedule records.
- text: Show every recurring schedule.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule'].put
update:
x-apievangelist-phrasing:
intent: Create a schedule record
effect: write
questions:
- How do I create a new recurring shift schedule?
- Can I overwrite an existing schedule record by its id?
instructions:
- text: Create schedule {id} named {name} from {start} {start_time} to {end} {end_time}.
slots:
id: requestBody.Id
name: requestBody.Name
start: requestBody.StartDate
start_time: requestBody.StartTime
end: requestBody.EndDate
end_time: requestBody.EndTime
- text: Create schedule {id} called {name} repeating {repeat_type} every {repeat_every}.
slots:
id: requestBody.Id
name: requestBody.Name
repeat_type: requestBody.RepeatType
repeat_every: requestBody.RepeatEvery
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule'].post
update:
x-apievangelist-phrasing:
intent: Create a recurring roster shift
effect: write
questions:
- How do I add a recurring roster shift for a worker on the roster?
- Can a roster shift repeat weekly or monthly and end on a specific date?
instructions:
- text: Create a roster shift {Name} from {StartDate} at {StartTime} to {EndTime}.
slots:
Name: requestBody.Name
StartDate: requestBody.StartDate
StartTime: requestBody.StartTime
EndTime: requestBody.EndTime
- text: Create recurring shift {Name} for {RepeatType} on {RepeatEvery} until {EndDate}.
slots:
Name: requestBody.Name
RepeatType: requestBody.RepeatType
RepeatEvery: requestBody.RepeatEvery
EndDate: requestBody.EndDate
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/BULK'].post
update:
x-apievangelist-phrasing:
intent: Create or update many schedules at once
effect: write
questions:
- Can I create or update several schedules in one request?
- How do I bulk upsert schedule records?
instructions:
- text: Bulk create or update these schedules.
- text: Apply this array of schedule records in one call.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get schedule field metadata
effect: read
questions:
- Which fields and associations does the Schedule resource have?
- What types are the schedule fields?
instructions:
- text: Get the field metadata for Schedule.
- text: Show which schedule fields are queryable.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing schedule for upserting
effect: read
questions:
- How do I find an existing schedule before creating it?
- Can I upsert a schedule by matching its fields?
instructions:
- text: Predict the existing schedule matching {id} named {name} from {start} {start_time} to {end} {end_time}.
slots:
id: requestBody.Id
name: requestBody.Name
start: requestBody.StartDate
start_time: requestBody.StartTime
end: requestBody.EndDate
end_time: requestBody.EndTime
- text: Find the schedule that matches {id} called {name} repeating {repeat_type} every {repeat_every}.
slots:
id: requestBody.Id
name: requestBody.Name
repeat_type: requestBody.RepeatType
repeat_every: requestBody.RepeatEvery
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search schedule records
effect: read
questions:
- Can I search schedules by name or date?
- How do I sort and page through schedule records?
instructions:
- text: Search schedules matching {search}.
slots:
search: requestBody.search
- text: Find schedules sorted by {sort}, {max} at a time.
slots:
sort: requestBody.sort
max: requestBody.max
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a schedule record
effect: read
questions:
- What are the details of one schedule?
- Can I fetch a schedule by its id?
instructions:
- text: Get schedule {id}.
slots:
id: path.id
- text: Show the details of schedule record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/{id}'].put
update:
x-apievangelist-phrasing:
intent: Replace a schedule record
effect: write
questions:
- How do I overwrite a schedule record?
- Can I fully replace a schedule with a new one?
instructions:
- text: Replace schedule {id} with name {name}, {start} {start_time} to {end} {end_time}.
slots:
id: path.id
name: requestBody.Name
start: requestBody.StartDate
start_time: requestBody.StartTime
end: requestBody.EndDate
end_time: requestBody.EndTime
- text: Overwrite schedule {id} so it repeats {repeat_type} every {repeat_every}.
slots:
id: path.id
repeat_type: requestBody.RepeatType
repeat_every: requestBody.RepeatEvery
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update a schedule record
effect: write
questions:
- Can I change a schedule's name or dates with a POST?
- How do I edit an existing schedule?
instructions:
- text: Update schedule {id} to name {name}, {start} {start_time} to {end} {end_time}.
slots:
id: path.id
name: requestBody.Name
start: requestBody.StartDate
start_time: requestBody.StartTime
end: requestBody.EndDate
end_time: requestBody.EndTime
- text: Change schedule {id} so it repeats {repeat_type} every {repeat_every}.
slots:
id: path.id
repeat_type: requestBody.RepeatType
repeat_every: requestBody.RepeatEvery
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a schedule record
effect: destructive
questions:
- How do I delete a schedule?
- Can I remove a recurring shift schedule?
instructions:
- text: Delete schedule {id}.
slots:
id: path.id
- text: Remove schedule record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a schedule
effect: read
questions:
- What comments have been left on a schedule?
- Can I read the comment history of a schedule?
instructions:
- text: List comments on schedule {id}.
slots:
id: path.id
- text: Show the comment history of schedule record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a schedule
effect: write
questions:
- How do I add a comment to a schedule?
- Can I annotate a schedule with a note?
instructions:
- text: Add comment {comment} to schedule {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Comment on schedule {id} saying {comment}.
slots:
id: path.id
comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a schedule
effect: destructive
questions:
- How do I remove a comment from a schedule?
- Can I delete a single comment on a schedule?
instructions:
- text: Delete comment {comment_id} from schedule {id}.
slots:
comment_id: path.commentId
id: path.id
- text: Remove the comment {comment_id} on schedule record {id}.
slots:
comment_id: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get a schedule's change history
effect: read
questions:
- What changes have been made to a schedule?
- Can I see the edit history of a schedule?
instructions:
- text: Show the change history of schedule {id}.
slots:
id: path.id
- text: List every edit made to schedule record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Schedule/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: View a schedule as it was at a past time
effect: read
questions:
- Can I see how a schedule looked at a specific moment?
- What did a schedule record contain at a given timestamp?
instructions:
- text: Show schedule {id} as it existed at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel to schedule record {id} on {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-schedule-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.