Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy Roster API
69 actions
69 updates
phrasing
extends
openapi/deputy-roster-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 69 · first 16 shown; the file carries all of them
$.info
$.paths['/my/roster/bids'].get
$.paths['/my/roster/bids/request'].post
$.paths['/my/roster/bids/withdraw'].post
$.paths['/my/roster/confirm'].post
$.paths['/my/roster/open'].get
$.paths['/my/roster/open'].post
$.paths['/my/roster/open/({startDate})(/{endDate})/{maxWaitTime}'].get
$.paths['/my/roster/publish/allow/({numOfRostersToPublish})'].get
$.paths['/my/roster/publish/count'].get
$.paths['/my/roster/startTimestamp/{startTimestamp}/reverse/{reverse}/limit/{limit}'].get
$.paths['/my/roster/swap/{startDate}/{endDate}'].get
$.paths['/my/roster/{id}'].get
$.paths['/my/roster/{id}/offer'].post
$.paths['/my/roster/{id}/offer/cancel'].post
$.paths['/my/roster/{id}/offer/getrecommendation'].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 Roster API
version: 1.0.0
extends: openapi/deputy-roster-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: 68
- target: $.paths['/my/roster/bids'].get
update:
x-apievangelist-phrasing:
intent: List my roster bids
effect: read
questions:
- Which roster bids have I made?
- Can I see all my roster bids at once?
instructions:
- text: List my roster bids.
- text: Show every roster bid I've placed.
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/bids/request'].post
update:
x-apievangelist-phrasing:
intent: Request a roster bid
effect: write
questions:
- How do I request a roster bid for a shift?
- Can I ask for a roster bid on a shift I'm interested in?
instructions:
- text: Request a roster bid.
- text: Place a new roster bid for a shift.
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/bids/withdraw'].post
update:
x-apievangelist-phrasing:
intent: Withdraw a roster bid
effect: destructive
questions:
- Can I withdraw a roster bid I placed by mistake?
- What happens to my roster bid once I withdraw it?
instructions:
- text: Withdraw my roster bids.
- text: Cancel all the roster bids I've made.
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/confirm'].post
update:
x-apievangelist-phrasing:
intent: Confirm a roster bid
effect: write
questions:
- How do I confirm a roster bid I've accepted?
- Can I confirm a roster bid so it's recorded?
instructions:
- text: Confirm my roster bid.
- text: Mark my roster bid as confirmed.
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/open'].get
update:
x-apievangelist-phrasing:
intent: List open roster shifts
effect: read
questions:
- Which roster shifts are still open for me to bid on?
- Can I see every open roster shift?
instructions:
- text: List the open roster shifts.
- text: Show all roster shifts that are still open.
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/open'].post
update:
x-apievangelist-phrasing:
intent: Bid on an open roster shift
effect: write
questions:
- How do I bid on an open roster shift?
- Can I place a bid on a shift that's still open?
instructions:
- text: Bid on an open roster shift.
- text: Place a bid on a roster shift that's still open.
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/open/({startDate})(/{endDate})/{maxWaitTime}'].get
update:
x-apievangelist-phrasing:
intent: Find open roster shifts within a wait time
effect: read
questions:
- Can I find open roster shifts that I'd have to wait at most a given time for?
- What roster shifts are open within a maximum wait time?
instructions:
- text: Find open roster shifts with a maximum wait time of {maxWaitTime} between {startDate} and {endDate}.
slots:
maxWaitTime: path.maxWaitTime
startDate: path.startDate
endDate: path.endDate
- text: Show roster shifts open between {startDate} and {endDate} where I wait no more than {maxWaitTime}.
slots:
startDate: path.startDate
endDate: path.endDate
maxWaitTime: path.maxWaitTime
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/publish/allow/({numOfRostersToPublish})'].get
update:
x-apievangelist-phrasing:
intent: Check how many rosters I can publish
effect: read
questions:
- How many rosters can I publish in one go?
- What does the roster publish limit allow?
instructions:
- text: Get the roster publish limit of {numOfRostersToPublish}.
slots:
numOfRostersToPublish: path.numOfRostersToPublish
- text: Tell me how many rosters I'm allowed to publish.
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/publish/count'].get
update:
x-apievangelist-phrasing:
intent: Count my roster shifts
effect: read
questions:
- How many roster shifts have I published?
- Can I get a count of my roster shifts?
instructions:
- text: Count my roster shifts.
- text: Tell me how many roster shifts I've published.
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/startTimestamp/{startTimestamp}/reverse/{reverse}/limit/{limit}'].get
update:
x-apievangelist-phrasing:
intent: List my roster rosters after a date
effect: read
questions:
- How do I pull roster rosters after a specific start date?
- Can I get my rosters newest first?
instructions:
- text: List my roster rosters from {startTimestamp} in {reverse} order, {limit} at a time.
slots:
startTimestamp: path.startTimestamp
reverse: path.reverse
limit: path.limit
- text: Show my roster rosters after {startTimestamp}, newest first.
slots:
startTimestamp: path.startTimestamp
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/swap/{startDate}/{endDate}'].get
update:
x-apievangelist-phrasing:
intent: List roster swaps for a period
effect: read
questions:
- Which roster swaps have been made between two dates?
- Can I see roster swaps for a specific period?
instructions:
- text: List roster swaps between {startDate} and {endDate}.
slots:
startDate: path.startDate
endDate: path.endDate
- text: Show roster swaps made between {startDate} and {endDate}.
slots:
startDate: path.startDate
endDate: path.endDate
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a roster shift
effect: read
questions:
- Can I look up one roster shift by its ID?
- What are the details of a specific roster shift?
instructions:
- text: Get roster shift {id}.
slots:
id: path.id
- text: Show the details of roster shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/{id}/offer'].post
update:
x-apievangelist-phrasing:
intent: Make an offer on a roster shift
effect: write
questions:
- How do I make an offer on a roster shift?
- Can I propose a bid on a roster shift I'm interested in?
instructions:
- text: Make an offer on roster shift {id}.
slots:
id: path.id
- text: Propose a bid on roster shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/{id}/offer/cancel'].post
update:
x-apievangelist-phrasing:
intent: Cancel an offer on a roster shift
effect: destructive
questions:
- Can I cancel an offer I made on a roster shift?
- What happens to my offer once I cancel it?
instructions:
- text: Cancel my offer on roster shift {id}.
slots:
id: path.id
- text: Withdraw the offer I made on roster shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/{id}/offer/getrecommendation'].get
update:
x-apievangelist-phrasing:
intent: Get an offer recommendation for a roster shift
effect: read
questions:
- What offer recommendation does the roster system give for a shift?
- Can I see a suggested offer amount for a roster shift?
instructions:
- text: Get the offer recommendation for roster shift {id}.
slots:
id: path.id
- text: Show the suggested offer for roster shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/{id}/offer/status'].get
update:
x-apievangelist-phrasing:
intent: Check an offer's status on a roster shift
effect: read
questions:
- Has my offer on a roster shift been accepted or rejected?
- What is the current status of an offer on a roster shift?
instructions:
- text: Check the offer status on roster shift {id}.
slots:
id: path.id
- text: Tell me whether my offer on roster shift {id} was accepted.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/{id}/swap/{action}'].post
update:
x-apievangelist-phrasing:
intent: Swap roster shifts
effect: write
questions:
- How do I swap roster shifts with another worker?
- Can I perform a roster swap on a shift?
instructions:
- text: Swap roster shift {id} with action {action}.
slots:
id: path.id
action: path.action
- text: Perform a roster swap on shift {id} using action {action}.
slots:
id: path.id
action: path.action
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/{id}/swapdetails'].get
update:
x-apievangelist-phrasing:
intent: Get swap details for a roster shift
effect: read
questions:
- What are the details of a roster swap on a shift?
- Can I see the swap history for a roster shift?
instructions:
- text: Get the swap details for roster shift {id}.
slots:
id: path.id
- text: Show the swap history of roster shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/my/roster/{startDate}/{endDate}'].get
update:
x-apievangelist-phrasing:
intent: List roster shifts for a period
effect: read
questions:
- Which roster shifts are scheduled between two dates?
- Can I see roster shifts for a specific date range?
instructions:
- text: List roster shifts between {startDate} and {endDate}.
slots:
startDate: path.startDate
endDate: path.endDate
- text: Show roster shifts scheduled between {startDate} and {endDate}.
slots:
startDate: path.startDate
endDate: path.endDate
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster'].get
update:
x-apievangelist-phrasing:
intent: List roster records
effect: read
questions:
- Which roster records can I see?
- Can I list roster records for a large roster table?
instructions:
- text: List my roster records.
- text: Show every roster record I'm permitted to see.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster'].put
update:
x-apievangelist-phrasing:
intent: Create a roster for a date and shift
effect: write
questions:
- How do I create a roster entry for a staff member on a given date?
- Can I set the start and end time of a rostered shift?
instructions:
- text: Create a roster for {employee} on {date} from {start} to {end}.
slots:
employee: requestBody.Employee
date: requestBody.Date
start: requestBody.StartTime
end: requestBody.EndTime
- text: Add a roster entry for {employee} on {date} between {start} and {end} with a {mealbreak} break.
slots:
employee: requestBody.Employee
date: requestBody.Date
start: requestBody.StartTime
end: requestBody.EndTime
mealbreak: requestBody.Mealbreak
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster'].post
update:
x-apievangelist-phrasing:
intent: Create a roster with start and end times
effect: write
questions:
- How do I create a new roster with a start time and end time?
- Can I set a meal break and total time on a new roster?
- Can I publish a roster right as I create it?
instructions:
- text: Create a roster record with ID {id} from {startTime} to {endTime}, last modified {modified}.
slots:
id: requestBody.Id
startTime: requestBody.StartTime
endTime: requestBody.EndTime
modified: requestBody.Modified
- text: Create a roster with ID {id} on {date} from {startTime} to {endTime}, modified {modified}, with a {mealbreak} meal break.
slots:
id: requestBody.Id
date: requestBody.Date
startTime: requestBody.StartTime
endTime: requestBody.EndTime
modified: requestBody.Modified
mealbreak: requestBody.Mealbreak
- text: Create a published roster with ID {id} from {startTime} to {endTime}, modified {modified}, with Published set to {published}.
slots:
id: requestBody.Id
startTime: requestBody.StartTime
endTime: requestBody.EndTime
modified: requestBody.Modified
published: requestBody.Published
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/BULK'].post
update:
x-apievangelist-phrasing:
intent: Create or update many roster entries
effect: write
questions:
- How do I import a batch of roster entries at once?
- Can I update several roster rows in one request?
instructions:
- text: Bulk create or update roster entries.
- text: Import this list of roster shifts in one batch.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get roster field metadata
effect: read
questions:
- Which fields can I search on when querying roster entries?
- What field types and associations does the roster resource have?
instructions:
- text: Get the roster field metadata.
- text: Show which roster fields are queryable.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing roster entry
effect: read
questions:
- Can I find the roster entry that matches a partial shift before creating it?
- Which existing roster row matches a given date and time?
instructions:
- text: Predict the roster entry matching {employee} on {date} from {start} to {end}.
slots:
employee: requestBody.Employee
date: requestBody.Date
start: requestBody.StartTime
end: requestBody.EndTime
- text: Find the existing roster row for {employee} on {date} between {start} and {end}.
slots:
employee: requestBody.Employee
date: requestBody.Date
start: requestBody.StartTime
end: requestBody.EndTime
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search roster entries
effect: read
questions:
- How do I find roster entries for a particular employee?
- Can I sort roster entries by date?
instructions:
- text: Search roster entries matching {search}.
slots:
search: requestBody.search
- text: Find roster entries for {search} sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a roster entry
effect: read
questions:
- How do I fetch one roster entry by its id?
- What shift and employee does a roster row record?
instructions:
- text: Get roster entry {id}.
slots:
id: path.id
- text: Show the shift recorded in roster row {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/{id}'].put
update:
x-apievangelist-phrasing:
intent: Replace a roster entry
effect: write
questions:
- How do I overwrite a roster entry with a new shift?
- Can I fully replace an existing roster row?
instructions:
- text: Replace roster entry {id} with a shift for {employee} on {date} from {start} to {end}.
slots:
id: path.id
employee: requestBody.Employee
date: requestBody.Date
start: requestBody.StartTime
end: requestBody.EndTime
- text: Overwrite roster row {id} with a new shift.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update a roster entry
effect: write
questions:
- How do I change the start time of an existing roster entry?
- Can I edit a roster row without replacing it?
instructions:
- text: Update roster entry {id} to start at {start} and end at {end}.
slots:
id: path.id
start: requestBody.StartTime
end: requestBody.EndTime
- text: Change the shift on roster row {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a roster entry
effect: destructive
questions:
- How do I remove a roster entry?
- Can I delete a shift from the roster?
instructions:
- text: Delete roster entry {id}.
slots:
id: path.id
- text: Remove the shift recorded in roster row {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a roster entry
effect: read
questions:
- What comments have been left on a roster entry?
- Can I read the notes on a shift?
instructions:
- text: List comments on roster entry {id}.
slots:
id: path.id
- text: Show the notes left on shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Add a comment to a roster entry
effect: write
questions:
- How do I add a note to a roster entry?
- Can I attach a comment to a shift?
instructions:
- text: Add comment {comment} to roster entry {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Attach a note to shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment from a roster entry
effect: destructive
questions:
- How do I remove a comment from a roster entry?
- Can I delete a note on a shift?
instructions:
- text: Delete comment {commentId} from roster entry {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the note {commentId} on shift {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history for a roster entry
effect: read
questions:
- What changes have been made to a roster entry over time?
- Can I see the edit history of a shift?
instructions:
- text: Get the change history of roster entry {id}.
slots:
id: path.id
- text: Show who changed shift {id} and when.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Roster/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: See a roster entry as it was at a past time
effect: read
questions:
- How did a roster entry look at a specific point in the past?
- Can I travel back to a roster row's state at a given timestamp?
instructions:
- text: Show roster entry {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to shift {id} at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster'].post
update:
x-apievangelist-phrasing:
intent: Create or update roster via the supervisor endpoint
effect: write
questions:
- How do I create or update roster entries through the supervisor endpoint?
- Can the supervisor endpoint add roster rows?
instructions:
- text: Use the supervisor endpoint to create or update roster entries.
- text: Send roster changes through the supervisor endpoint.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/autobuild'].post
update:
x-apievangelist-phrasing:
intent: Autobuild roster entries
effect: write
questions:
- How do I automatically build roster entries from a schedule?
- Can the supervisor autobuild roster rows?
instructions:
- text: Autobuild roster entries.
- text: Build the roster automatically from the schedule.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/autobuildfromagreedhours'].post
update:
x-apievangelist-phrasing:
intent: Autobuild roster from agreed hours
effect: write
questions:
- Can roster entries be built from agreed hours?
- How do I autobuild roster rows from staff's agreed hours?
instructions:
- text: Autobuild roster entries from agreed hours.
- text: Build the roster using staff's agreed hours.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/autobuildfromgfe'].post
update:
x-apievangelist-phrasing:
intent: Autobuild roster from GFE
effect: write
questions:
- How do I build roster entries from a GFE file?
- Can the supervisor autobuild roster rows from a GFE?
instructions:
- text: Autobuild roster entries from a GFE file.
- text: Build the roster using a GFE file.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/autofill'].post
update:
x-apievangelist-phrasing:
intent: Autofill roster entries
effect: write
questions:
- How do I autofill roster entries with staff?
- Can the supervisor autofill roster rows?
instructions:
- text: Autofill roster entries.
- text: Fill the roster automatically with staff.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/bid/approve'].post
update:
x-apievangelist-phrasing:
intent: Approve a roster bid
effect: write
questions:
- How do I approve a roster bid that has been submitted?
- Can a roster bid be accepted before the shift starts?
instructions:
- text: Approve this roster bid.
- text: Confirm the bid on the roster.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/cancelautofill'].post
update:
x-apievangelist-phrasing:
intent: Cancel an autofilled roster
effect: destructive
questions:
- Can I undo an autofilled roster before it is published?
- What happens to staff when an autofilled roster is cancelled?
instructions:
- text: Cancel the autofilled roster.
- text: Discard the roster autofill.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/checkautobuild/{jobKey}'].get
update:
x-apievangelist-phrasing:
intent: Check an auto-built roster
effect: read
questions:
- Has the roster been auto-built yet?
- Can I check the status of an auto-built roster job?
instructions:
- text: Check auto-built roster job {jobKey}.
slots:
jobKey: path.jobKey
- text: Get the status of auto-build job {jobKey}.
slots:
jobKey: path.jobKey
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/checkautobuildfromagreedhours/{jobKey}'].post
update:
x-apievangelist-phrasing:
intent: Build roster from agreed hours
effect: write
questions:
- Can I build a roster from staff's agreed hours?
- What does the auto-build-from-agreed-hours call return?
instructions:
- text: Build the roster from agreed hours using job {jobKey}.
slots:
jobKey: path.jobKey
- text: Auto-build roster {jobKey} from agreed hours.
slots:
jobKey: path.jobKey
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/checkautobuildfromgfe/{jobKey}'].post
update:
x-apievangelist-phrasing:
intent: Build roster from GFE hours
effect: write
questions:
- Can I build a roster from hours recorded in GFE?
- What does the auto-build-from-gfe call return?
instructions:
- text: Build the roster from GFE hours using job {jobKey}.
slots:
jobKey: path.jobKey
- text: Auto-build roster {jobKey} from GFE hours.
slots:
jobKey: path.jobKey
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/checkautofill/{jobKey}'].get
update:
x-apievangelist-phrasing:
intent: Check an autofilled roster
effect: read
questions:
- Has the roster autofill completed?
- Can I check the status of an autofilled roster job?
instructions:
- text: Check autofilled roster job {jobKey}.
slots:
jobKey: path.jobKey
- text: Get the status of autofill job {jobKey}.
slots:
jobKey: path.jobKey
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/connect-info'].post
update:
x-apievangelist-phrasing:
intent: Connect roster info
effect: write
questions:
- How do I connect roster information for a roster?
- Can I send roster connection info to the roster endpoint?
instructions:
- text: Connect roster info.
- text: Send roster connection information.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/copy'].post
update:
x-apievangelist-phrasing:
intent: Copy a roster
effect: write
questions:
- Can I copy a roster to another location?
- How do I duplicate a roster?
instructions:
- text: Copy this roster.
- text: Duplicate the roster.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/copy/batch'].post
update:
x-apievangelist-phrasing:
intent: Copy many rosters in one request
effect: write
questions:
- Can I copy several rosters at once?
- Is there a batch roster copy call?
instructions:
- text: Copy these rosters in one batch.
- text: Batch duplicate the selected rosters.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/discard'].post
update:
x-apievangelist-phrasing:
intent: Discard a roster
effect: destructive
questions:
- Can I throw away a roster I built but haven't published?
- What happens to a discarded roster?
instructions:
- text: Discard this roster.
- text: Throw away the roster.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/notifymanager/{id}'].get
update:
x-apievangelist-phrasing:
intent: Notify a roster manager
effect: read
questions:
- How do I notify a roster manager about a roster?
- Can I get roster manager notification details?
instructions:
- text: Notify roster manager {id}.
slots:
id: path.id
- text: Get roster manager notification {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/pending-approval-swap-details/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get pending roster swap details
effect: read
questions:
- What is pending approval on a roster swap?
- Can I see the details of a roster swap waiting for approval?
instructions:
- text: Get pending roster swap details {id}.
slots:
id: path.id
- text: Show the roster swap {id} awaiting approval.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/publish'].post
update:
x-apievangelist-phrasing:
intent: Publish a roster
effect: write
questions:
- How do I publish a roster so staff can see it?
- Can I publish a roster after it has been built?
instructions:
- text: Publish this roster.
- text: Make the roster live.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/shift/setup'].post
update:
x-apievangelist-phrasing:
intent: Set up a roster shift
effect: write
questions:
- Can I set up a roster shift before the roster is built?
- What does the roster shift setup call do?
instructions:
- text: Set up a roster shift.
- text: Prepare a shift for the roster.
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/swap/{action}'].post
update:
x-apievangelist-phrasing:
intent: Swap roster shifts
effect: write
questions:
- Can I swap two roster shifts?
- What does the roster swap action call do?
instructions:
- text: Swap roster shifts with action {action}.
slots:
action: path.action
- text: Apply roster swap action {action}.
slots:
action: path.action
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/swap/{startDate}/{endDate}'].get
update:
x-apievangelist-phrasing:
intent: Swap roster shifts for a date range
effect: read
questions:
- Can I swap roster shifts for a specific date range?
- What does the roster swap for a date range call return?
instructions:
- text: Swap roster shifts from {startDate} to {endDate}.
slots:
startDate: path.startDate
endDate: path.endDate
- text: Get roster swap details for {startDate} through {endDate}.
slots:
startDate: path.startDate
endDate: path.endDate
method: generated
generated: '2026-11-17'
- target: $.paths['/supervise/roster/systemtemplate/copy'].post
update:
x-apievangelist-phrasing:
intent: Copy a system roster template
effect: write
questions:
- Can I copy a system roster template?
- How do I duplicate a system template?
instructions:
- text: Copy this system roster template.
- text: Duplicate the system template.
method: generated
generated: '2026-11-17'
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://artifacts.apis.io/deputy/overlays/deputy-roster-api-phrasing-overlay.yaml
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-roster-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.