Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Roster Open API
11 actions
11 updates
phrasing
extends
openapi/deputy-rosteropen-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/RosterOpen'].get
$.paths['/resource/RosterOpen/INFO'].get
$.paths['/resource/RosterOpen/PREDICT'].post
$.paths['/resource/RosterOpen/QUERY'].post
$.paths['/resource/RosterOpen/{id}'].get
$.paths['/resource/RosterOpen/{id}/COMMENTS'].get
$.paths['/resource/RosterOpen/{id}/COMMENTS'].post
$.paths['/resource/RosterOpen/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/RosterOpen/{id}/HISTORY'].get
$.paths['/resource/RosterOpen/{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 Open API
version: 1.0.0
extends: openapi/deputy-rosteropen-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/RosterOpen'].get
update:
x-apievangelist-phrasing:
intent: List open roster records
effect: read
questions:
- Which roster open records can I see?
- Is there a paginated way to list open roster entries?
instructions:
- text: List my open roster records.
- text: Show every RosterOpen entry I have permission to see.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterOpen/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get field metadata for open roster
effect: read
questions:
- Which fields and associations does the RosterOpen resource have?
- What types are the open roster fields?
instructions:
- text: Show the field metadata for RosterOpen.
- text: List the queryable fields and associations of open roster.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterOpen/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Predict an existing open roster record
effect: read
questions:
- Can I find an existing open roster record from a partial payload before creating?
- Which fields does the RosterOpen predict-match need?
instructions:
- text: Predict-match an open roster record for Roster {Roster}, Employee {Employee} on link {Link}.
slots:
Roster: requestBody.Roster
Employee: requestBody.Employee
Link: requestBody.Link
- text: Find the existing RosterOpen record matching {Roster}, {Employee} and {Link} with modified {Modified}.
slots:
Roster: requestBody.Roster
Employee: requestBody.Employee
Link: requestBody.Link
Modified: requestBody.Modified
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterOpen/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search open roster records
effect: read
questions:
- Can I search open roster records with sorting and joins?
- What is the maximum page size for RosterOpen search?
instructions:
- text: Search open roster records matching {search}.
slots:
search: requestBody.search
- text: Find RosterOpen entries matching {search}, sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterOpen/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an open roster record
effect: read
questions:
- What are the details of one open roster record?
- Can I fetch a RosterOpen by id?
instructions:
- text: Get open roster record {id}.
slots:
id: path.id
- text: Show the RosterOpen entry {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterOpen/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on an open roster record
effect: read
questions:
- What comments have been left on an open roster record?
- Can I see the comment history of a RosterOpen?
instructions:
- text: List comments on open roster record {id}.
slots:
id: path.id
- text: Show the comment thread for RosterOpen {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterOpen/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Add a comment to an open roster record
effect: write
questions:
- Can I add a comment to an open roster record?
- How do I comment on a RosterOpen entry?
instructions:
- text: Add comment {Comment} to open roster record {id}.
slots:
Comment: requestBody.Comment
id: path.id
- text: Comment {Comment} on RosterOpen {id}.
slots:
Comment: requestBody.Comment
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterOpen/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment from an open roster record
effect: destructive
questions:
- Can I delete a comment on an open roster record?
- How do I remove a comment from a RosterOpen?
instructions:
- text: Delete comment {commentId} from open roster record {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove RosterOpen comment {commentId} on record {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterOpen/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history of an open roster record
effect: read
questions:
- What changes have been made to an open roster record?
- Can I see the edit history of a RosterOpen?
instructions:
- text: Show the change history of open roster record {id}.
slots:
id: path.id
- text: List edits made to RosterOpen {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/RosterOpen/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: Get an open roster record as it was at a time
effect: read
questions:
- Can I see an open roster record as it looked at a past moment?
- What did a RosterOpen record contain at a given timestamp?
instructions:
- text: Show RosterOpen {id} as it existed at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to RosterOpen {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-rosteropen-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.