Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Shift Template API

17 actions 17 updates phrasing extends openapi/deputy-shifttemplate-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 17 · first 16 shown; the file carries all of them

$.info
$.paths['/resource/ShiftTemplate'].get
$.paths['/resource/ShiftTemplate'].put
$.paths['/resource/ShiftTemplate'].post
$.paths['/resource/ShiftTemplate/BULK'].post
$.paths['/resource/ShiftTemplate/INFO'].get
$.paths['/resource/ShiftTemplate/PREDICT'].post
$.paths['/resource/ShiftTemplate/QUERY'].post
$.paths['/resource/ShiftTemplate/{id}'].get
$.paths['/resource/ShiftTemplate/{id}'].put
$.paths['/resource/ShiftTemplate/{id}'].post
$.paths['/resource/ShiftTemplate/{id}'].delete
$.paths['/resource/ShiftTemplate/{id}/COMMENTS'].get
$.paths['/resource/ShiftTemplate/{id}/COMMENTS'].post
$.paths['/resource/ShiftTemplate/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/ShiftTemplate/{id}/HISTORY'].get

OpenAPI Overlay

Raw ↑
# 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 Shift Template API
  version: 1.0.0
extends: openapi/deputy-shifttemplate-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/ShiftTemplate'].get
  update:
    x-apievangelist-phrasing:
      intent: List shift templates
      effect: read
      questions:
      - Which shift templates exist in my Deputy account?
      - Can I page through all shift templates?
      instructions:
      - text: List all shift templates.
      - text: Show every shift template record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a shift template
      effect: write
      questions:
      - How do I create a shift template with a schedule?
      - Can I replace a shift template by its ID?
      instructions:
      - text: Create shift template {id} named {name} on schedule {schedule}, active {active}, auto-commit breaks {autoCommitBreak}.
        slots:
          id: requestBody.Id
          name: requestBody.Name
          schedule: requestBody.Schedule
          active: requestBody.Active
          autoCommitBreak: requestBody.AutoCommitBreak
      - text: Create shift template {id} with schedule {schedule}, active {active}, auto-commit breaks {autoCommitBreak}, block early break start {blockEarlyBreakStart}.
        slots:
          id: requestBody.Id
          schedule: requestBody.Schedule
          active: requestBody.Active
          autoCommitBreak: requestBody.AutoCommitBreak
          blockEarlyBreakStart: requestBody.BlockEarlyBreakStart
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shift template
      effect: write
      questions:
      - How do I define a recurring shift template for a schedule?
      - Can a new shift template block employees ending breaks too early?
      instructions:
      - text: Create shift template {name} on schedule {schedule} active {active}.
        slots:
          name: requestBody.Name
          schedule: requestBody.Schedule
          active: requestBody.Active
      - text: Add shift template {name} to {schedule} with auto-commit breaks set to {auto_commit}.
        slots:
          name: requestBody.Name
          schedule: requestBody.Schedule
          auto_commit: requestBody.AutoCommitBreak
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many shift templates
      effect: write
      questions:
      - Can I create or update several shift templates in one call?
      - How do I bulk upsert shift templates?
      instructions:
      - text: Bulk create or update these shift templates.
      - text: Upsert a batch of shift templates in one request.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shift template field metadata
      effect: read
      questions:
      - Which fields and types does a shift template have?
      - What associations exist on the shift template resource?
      instructions:
      - text: Show the field metadata for shift templates.
      - text: List shift template fields, types and associations.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find a matching shift template
      effect: read
      questions:
      - Can I find an existing shift template that matches a partial payload?
      - Which shift template does a new shift template most resemble?
      instructions:
      - text: Predict-match a shift template for {id} named {name} on schedule {schedule}, active {active}, auto-commit breaks {autoCommitBreak}.
        slots:
          id: requestBody.Id
          name: requestBody.Name
          schedule: requestBody.Schedule
          active: requestBody.Active
          autoCommitBreak: requestBody.AutoCommitBreak
      - text: Find the closest existing shift template to {id} named {name} on schedule {schedule}, active {active}, auto-commit breaks {autoCommitBreak}.
        slots:
          id: requestBody.Id
          name: requestBody.Name
          schedule: requestBody.Schedule
          active: requestBody.Active
          autoCommitBreak: requestBody.AutoCommitBreak
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search shift templates
      effect: read
      questions:
      - How do I find shift templates by schedule?
      - Can I sort and page shift template search results?
      instructions:
      - text: Search shift templates where {search}.
        slots:
          search: requestBody.search
      - text: Find shift templates matching {search}, sorted by {sort}, {max} at a time.
        slots:
          search: requestBody.search
          sort: requestBody.sort
          max: requestBody.max
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shift template
      effect: read
      questions:
      - What schedule and slots does a shift template have?
      - Can I fetch one shift template by ID?
      instructions:
      - text: Get shift template {id}.
        slots:
          id: path.id
      - text: Show the schedule and slots of shift template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a shift template
      effect: write
      questions:
      - Can I change the schedule or slots on an existing shift template?
      - Which fields must match exactly on a shift template update?
      instructions:
      - text: Update shift template {id} with schedule {schedule}, active {active}.
        slots:
          id: path.id
          schedule: requestBody.Schedule
          active: requestBody.Active
      - text: Replace shift template {id} so its slots are {slots}.
        slots:
          id: path.id
          slots: requestBody.Slots
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a shift template
      effect: write
      questions:
      - How do I change a shift template's schedule?
      - Can I deactivate a shift template?
      instructions:
      - text: Update shift template {id} to schedule {schedule}, active {active}, auto-commit breaks {autoCommitBreak}.
        slots:
          id: path.id
          schedule: requestBody.Schedule
          active: requestBody.Active
          autoCommitBreak: requestBody.AutoCommitBreak
      - text: Deactivate shift template {id} by setting active {active}.
        slots:
          id: path.id
          active: requestBody.Active
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shift template
      effect: destructive
      questions:
      - How do I delete a shift template?
      - Can I remove a shift template by ID?
      instructions:
      - text: Delete shift template {id}.
        slots:
          id: path.id
      - text: Remove shift template {id} from the account.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a shift template
      effect: read
      questions:
      - What comments have been left on a shift template?
      - Can I read the comment history of a shift template?
      instructions:
      - text: List comments on shift template {id}.
        slots:
          id: path.id
      - text: Show the comment history of shift template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a shift template
      effect: write
      questions:
      - How do I comment on a shift template?
      - Can I leave a note on a shift template?
      instructions:
      - text: Comment {comment} on shift template {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: 'Add a note to shift template {id}: {comment}.'
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a shift template
      effect: destructive
      questions:
      - How do I delete a comment from a shift template?
      - Can I remove one comment on a shift template?
      instructions:
      - text: Delete comment {commentId} from shift template {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove comment {commentId} on shift template {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shift template's change history
      effect: read
      questions:
      - What changes have been made to a shift template?
      - Can I see the edit history of a shift template?
      instructions:
      - text: Show the change history of shift template {id}.
        slots:
          id: path.id
      - text: List edits made to shift template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/ShiftTemplate/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a shift template as it was at a past time
      effect: read
      questions:
      - Can I see what a shift template looked like at a past moment?
      - How do I travel back to a shift template's state at a timestamp?
      instructions:
      - text: Show shift template {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to shift template {id} at {timestamp} and show its state.
        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.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-shifttemplate-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.