Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Roster Swap API
11 actions
11 updates
phrasing
extends
openapi/deputy-rosterswap-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/RosterSwap'].get
$.paths['/resource/RosterSwap/INFO'].get
$.paths['/resource/RosterSwap/PREDICT'].post
$.paths['/resource/RosterSwap/QUERY'].post
$.paths['/resource/RosterSwap/{id}'].get
$.paths['/resource/RosterSwap/{id}/COMMENTS'].get
$.paths['/resource/RosterSwap/{id}/COMMENTS'].post
$.paths['/resource/RosterSwap/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/RosterSwap/{id}/HISTORY'].get
$.paths['/resource/RosterSwap/{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 Roster Swap API
version: 1.0.0
extends: openapi/deputy-rosterswap-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/RosterSwap'].get
update:
x-apievangelist-phrasing:
intent: List roster swap requests
effect: read
questions:
- Which roster swap requests have been raised?
- Can I page through all roster swap records?
instructions:
- text: List all roster swap records.
- text: Show every roster swap request.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterSwap/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get roster swap field metadata
effect: read
questions:
- Which fields can I search roster swap records on?
- What data types do roster swap fields have?
instructions:
- text: Get the roster swap field metadata.
- text: Show which roster swap fields are queryable.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterSwap/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing roster swap
effect: read
questions:
- Can I find an existing roster swap before creating a duplicate?
- What fields does the roster swap predict match use?
instructions:
- text: Predict a roster swap for employee {Employee} swapping from {SourceRoster} to {TargetRoster}.
slots:
Employee: requestBody.Employee
SourceRoster: requestBody.SourceRoster
TargetRoster: requestBody.TargetRoster
- text: Find the existing roster swap for {Employee} on {SourceRoster} with status {Status}.
slots:
Employee: requestBody.Employee
SourceRoster: requestBody.SourceRoster
Status: requestBody.Status
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterSwap/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search roster swap records
effect: read
questions:
- Can I find roster swaps raised by a particular employee?
- How do I sort roster swap search results?
instructions:
- text: Search roster swaps matching {search}.
slots:
search: requestBody.search
- text: Find roster swaps sorted by {sort}.
slots:
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterSwap/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a roster swap
effect: read
questions:
- What are the details of one roster swap?
- Can I look up a roster swap by id?
instructions:
- text: Get roster swap {id}.
slots:
id: path.id
- text: Show the details of roster swap {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterSwap/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a roster swap
effect: read
questions:
- What comments have been left on a roster swap?
- Can I see the discussion history on a swap request?
instructions:
- text: List comments on roster swap {id}.
slots:
id: path.id
- text: Show the comment thread for roster swap {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterSwap/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a roster swap
effect: write
questions:
- Can I add a comment to a roster swap?
- How do I annotate a swap request with a note?
instructions:
- text: Comment {Comment} on roster swap {id}.
slots:
Comment: requestBody.Comment
id: path.id
- text: 'Add a note to roster swap {id}: {Comment}.'
slots:
id: path.id
Comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterSwap/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a roster swap
effect: destructive
questions:
- Can I remove a comment from a roster swap?
- Is it possible to delete a comment on a swap request?
instructions:
- text: Delete comment {commentId} from roster swap {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the comment {commentId} on roster swap {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterSwap/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history of a roster swap
effect: read
questions:
- Who changed a roster swap and when?
- Can I see the edit history of a swap request?
instructions:
- text: Show the change history of roster swap {id}.
slots:
id: path.id
- text: List every edit made to roster swap {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterSwap/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: See a roster swap as it was at a past time
effect: read
questions:
- What did a roster swap look like before it was changed?
- Can I view a swap request as it existed at a specific moment?
instructions:
- text: Show roster swap {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to roster swap {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-rosterswap-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.