Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Employee Contracted Hours Shift API
17 actions
17 updates
phrasing
extends
openapi/deputy-employeecontractedhoursshift-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/EmployeeContractedHoursShift'].get
$.paths['/resource/EmployeeContractedHoursShift'].put
$.paths['/resource/EmployeeContractedHoursShift'].post
$.paths['/resource/EmployeeContractedHoursShift/BULK'].post
$.paths['/resource/EmployeeContractedHoursShift/INFO'].get
$.paths['/resource/EmployeeContractedHoursShift/PREDICT'].post
$.paths['/resource/EmployeeContractedHoursShift/QUERY'].post
$.paths['/resource/EmployeeContractedHoursShift/{id}'].get
$.paths['/resource/EmployeeContractedHoursShift/{id}'].put
$.paths['/resource/EmployeeContractedHoursShift/{id}'].post
$.paths['/resource/EmployeeContractedHoursShift/{id}'].delete
$.paths['/resource/EmployeeContractedHoursShift/{id}/COMMENTS'].get
$.paths['/resource/EmployeeContractedHoursShift/{id}/COMMENTS'].post
$.paths['/resource/EmployeeContractedHoursShift/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmployeeContractedHoursShift/{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 Contracted Hours Shift API
version: 1.0.0
extends: openapi/deputy-employeecontractedhoursshift-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/EmployeeContractedHoursShift'].get
update:
x-apievangelist-phrasing:
intent: List contracted hours shifts
effect: read
questions:
- Which contracted hours shifts are set up for a team member?
- Can I see the weekly contracted hours shift for an employee?
instructions:
- text: List all contracted hours shifts.
- text: Show the weekly contracted hours shifts.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift'].put
update:
x-apievangelist-phrasing:
intent: Replace a contracted hours shift
effect: write
questions:
- How do I overwrite an existing contracted hours shift for an employee?
- Can I replace a weekly contracted hours shift with a new one?
instructions:
- text: Replace contracted hours shift {id} for employee {employee} on {day} from {start} to {end}.
slots:
id: requestBody.Id
employee: requestBody.EmployeeContractedHoursId
day: requestBody.DayOfWeek
start: requestBody.StartTime
end: requestBody.EndTime
- text: Overwrite the existing contracted hours shift {id}.
slots:
id: requestBody.Id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift'].post
update:
x-apievangelist-phrasing:
intent: Create a contracted hours shift
effect: write
questions:
- How do I add a new contracted hours shift for an employee?
- Can I create a weekly contracted hours shift for a team member?
instructions:
- text: Create a contracted hours shift for employee {employee} on {day} from {start} to {end}.
slots:
employee: requestBody.EmployeeContractedHoursId
day: requestBody.DayOfWeek
start: requestBody.StartTime
end: requestBody.EndTime
- text: Add a new contracted hours shift record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/BULK'].post
update:
x-apievangelist-phrasing:
intent: Bulk create or update contracted hours shifts
effect: write
questions:
- Can I create many contracted hours shifts in one request?
- How do I bulk upsert contracted hours shifts?
instructions:
- text: Bulk create or update these contracted hours shifts.
- text: Upsert a batch of contracted hours shifts.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get contracted hours shift field metadata
effect: read
questions:
- Which fields can I query on a contracted hours shift?
- What field types and associations does the contracted hours shift resource have?
instructions:
- text: Show the field metadata for contracted hours shifts.
- text: Get the queryable fields for contracted hours shift records.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing contracted hours shift
effect: read
questions:
- Is there already a contracted hours shift that matches this partial record?
- Can I predict an existing contracted hours shift before creating one?
instructions:
- text: Predict the existing contracted hours shift matching {employee} on {day} from {start} to {end}.
slots:
employee: requestBody.EmployeeContractedHoursId
day: requestBody.DayOfWeek
start: requestBody.StartTime
end: requestBody.EndTime
- text: Find the closest existing contracted hours shift for this payload.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search contracted hours shifts
effect: read
questions:
- How do I find contracted hours shifts that match a search?
- Can I sort and page through contracted hours shifts?
instructions:
- text: Search contracted hours shifts matching {search}.
slots:
search: requestBody.search
- text: Find contracted hours shifts sorted by {sort}, {max} at a time.
slots:
sort: requestBody.sort
max: requestBody.max
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a contracted hours shift
effect: read
questions:
- What are the details of one contracted hours shift?
- Can I fetch a single contracted hours shift by id?
instructions:
- text: Get contracted hours shift {id}.
slots:
id: path.id
- text: Show the contracted hours shift record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/{id}'].put
update:
x-apievangelist-phrasing:
intent: Replace a contracted hours shift
effect: write
questions:
- How do I overwrite an existing contracted hours shift record?
- Can I fully replace a contracted hours shift with a new one?
instructions:
- text: Replace contracted hours shift {id} with {employee} on {day} from {start} to {end}.
slots:
id: path.id
employee: requestBody.EmployeeContractedHoursId
day: requestBody.DayOfWeek
start: requestBody.StartTime
end: requestBody.EndTime
- text: Overwrite the full contracted hours shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update a contracted hours shift
effect: write
questions:
- How do I change an existing contracted hours shift?
- Can I edit the start and end time of a contracted hours shift?
instructions:
- text: Update contracted hours shift {id} for {employee} on {day} from {start} to {end}.
slots:
id: path.id
employee: requestBody.EmployeeContractedHoursId
day: requestBody.DayOfWeek
start: requestBody.StartTime
end: requestBody.EndTime
- text: Edit the existing contracted hours shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a contracted hours shift
effect: destructive
questions:
- How do I remove a contracted hours shift?
- Can I delete a weekly contracted hours shift?
instructions:
- text: Delete contracted hours shift {id}.
slots:
id: path.id
- text: Remove the contracted hours shift record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a contracted hours shift
effect: read
questions:
- What comments have been left on a contracted hours shift?
- Can I see the comment history for a contracted hours shift?
instructions:
- text: List comments on contracted hours shift {id}.
slots:
id: path.id
- text: Show the comment history for contracted hours shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a contracted hours shift
effect: write
questions:
- How do I leave a comment on a contracted hours shift?
- Can I annotate a contracted hours shift with a note?
instructions:
- text: Comment {comment} on contracted hours shift {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Add a note to contracted hours shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a contracted hours shift
effect: destructive
questions:
- How do I remove a comment from a contracted hours shift?
- Can I delete a comment on a contracted hours shift?
instructions:
- text: Delete comment {commentId} from contracted hours shift {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the comment {commentId} on contracted hours shift {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history for a contracted hours shift
effect: read
questions:
- Who changed a contracted hours shift and when?
- Can I see the change history of a contracted hours shift?
instructions:
- text: Show the change history of contracted hours shift {id}.
slots:
id: path.id
- text: List the edit history for contracted hours shift {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeContractedHoursShift/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: Get a contracted hours shift as it was at a past time
effect: read
questions:
- What did a contracted hours shift look like at a specific past time?
- Can I view a contracted hours shift record as it existed at a timestamp?
instructions:
- text: Get contracted hours shift {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Show the contracted hours shift {id} as of {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-employeecontractedhoursshift-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.