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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Deputy V2 Publish Shifts API
version: 1.0.0
extends: openapi/deputy-publishshifts-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: 3
- target: $.paths['/management/v2/shifts-publishing/resume/{jobId}'].get
update:
x-apievangelist-phrasing:
intent: Resume a shift publishing job
effect: write
questions:
- How do I resume a shift publishing job that was paused?
- Can I restart a shift publishing job by its job ID?
instructions:
- text: Resume shift publishing job {jobId}.
slots:
jobId: path.jobId
- text: Restart the paused shift publishing job {jobId}.
slots:
jobId: path.jobId
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/shifts-publishing/status/{jobId}'].get
update:
x-apievangelist-phrasing:
intent: Check a shift publishing job's status
effect: read
questions:
- Has my shift publishing job finished?
- What status is a shift publishing job in right now?
instructions:
- text: Get the status of shift publishing job {jobId}.
slots:
jobId: path.jobId
- text: Check whether shift publishing job {jobId} has completed.
slots:
jobId: path.jobId
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/shifts/publish/preview'].post
update:
x-apievangelist-phrasing:
intent: Preview shifts to be published
effect: read
questions:
- Which shifts will be published to staff for a date range?
- Can I preview unpublished shifts for specific locations?
instructions:
- text: Preview shifts to be published between {startDate} and {endDate}.
slots:
startDate: requestBody.startDate
endDate: requestBody.endDate
- text: Show unpublished shifts at locations {locationIds}.
slots:
locationIds: requestBody.locationIds
method: generated
generated: '2026-11-17'
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.