Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Roster Template API

17 actions 17 updates phrasing extends openapi/deputy-rostertemplate-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/RosterTemplate'].get
$.paths['/resource/RosterTemplate'].put
$.paths['/resource/RosterTemplate'].post
$.paths['/resource/RosterTemplate/BULK'].post
$.paths['/resource/RosterTemplate/INFO'].get
$.paths['/resource/RosterTemplate/PREDICT'].post
$.paths['/resource/RosterTemplate/QUERY'].post
$.paths['/resource/RosterTemplate/{id}'].get
$.paths['/resource/RosterTemplate/{id}'].put
$.paths['/resource/RosterTemplate/{id}'].post
$.paths['/resource/RosterTemplate/{id}'].delete
$.paths['/resource/RosterTemplate/{id}/COMMENTS'].get
$.paths['/resource/RosterTemplate/{id}/COMMENTS'].post
$.paths['/resource/RosterTemplate/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/RosterTemplate/{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 Roster Template API
  version: 1.0.0
extends: openapi/deputy-rostertemplate-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/RosterTemplate'].get
  update:
    x-apievangelist-phrasing:
      intent: List roster templates
      effect: read
      questions:
      - What roster templates exist in my company?
      - Can I page through all roster templates?
      instructions:
      - text: List all roster templates.
      - text: Show every roster template record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a roster template
      effect: write
      questions:
      - How do I create a roster template with its shifts and dates?
      - Can I replace a roster template by its ID?
      instructions:
      - text: Create roster template {id} named {name} of type {type} for company {company} covering {start} to {end}.
        slots:
          id: requestBody.Id
          name: requestBody.Name
          type: requestBody.Type
          company: requestBody.Company
          start: requestBody.StartFrom
          end: requestBody.EndTo
      - text: Create roster template {id} with shifts {shifts} and total count {count}.
        slots:
          id: requestBody.Id
          shifts: requestBody.Shifts
          count: requestBody.TotalCount
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a roster template
      effect: write
      questions:
      - How do I build a recurring roster from a set of shifts?
      - Can a roster template start on a specific start date and end on an end date?
      - What do I need to define for a new roster template?
      instructions:
      - text: Create roster template {Name} of type {Type} for company {Company}.
        slots:
          Name: requestBody.Name
          Type: requestBody.Type
          Company: requestBody.Company
      - text: Create a roster template named {Name} with shifts {Shifts} starting {StartFrom} and ending {EndTo}.
        slots:
          Name: requestBody.Name
          Shifts: requestBody.Shifts
          StartFrom: requestBody.StartFrom
          EndTo: requestBody.EndTo
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update roster templates in bulk
      effect: write
      questions:
      - Can I create many roster templates in one request?
      - How do I update roster templates in bulk?
      instructions:
      - text: Bulk create or update roster templates.
      - text: Process this batch of roster templates together.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get roster template field metadata
      effect: read
      questions:
      - Which fields can I search roster templates by?
      - What types and associations does roster template have?
      instructions:
      - text: Show roster template field metadata.
      - text: List the fields, types and associations for roster templates.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing roster template
      effect: read
      questions:
      - Can I find the closest existing roster template for a partial payload?
      - What roster template already matches this name and shifts?
      instructions:
      - text: Predict the roster template matching {name} of type {type} for company {company} covering {start} to {end}.
        slots:
          name: requestBody.Name
          type: requestBody.Type
          company: requestBody.Company
          start: requestBody.StartFrom
          end: requestBody.EndTo
      - text: Find the existing roster template for shifts {shifts} and total count {count}.
        slots:
          shifts: requestBody.Shifts
          count: requestBody.TotalCount
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search roster templates
      effect: read
      questions:
      - Can I search roster templates by name or shifts?
      - How do I sort roster templates and page through them?
      instructions:
      - text: Search roster templates matching {search}.
        slots:
          search: requestBody.search
      - text: Find roster templates sorted by {sort}, {max} at a time.
        slots:
          sort: requestBody.sort
          max: requestBody.max
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a roster template
      effect: read
      questions:
      - What shifts and dates does a roster template cover?
      - Can I fetch one roster template by its ID?
      instructions:
      - text: Get roster template {id}.
        slots:
          id: path.id
      - text: Show the shifts and dates of roster template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a roster template
      effect: write
      questions:
      - How do I overwrite a roster template's shifts and dates?
      - Can I fully replace a roster template record?
      instructions:
      - text: Replace roster template {id} with shifts {shifts} and total count {count}.
        slots:
          id: path.id
          shifts: requestBody.Shifts
          count: requestBody.TotalCount
      - text: Overwrite roster template {id} with name {name}, type {type}, company {company}, {start} to {end}.
        slots:
          id: path.id
          name: requestBody.Name
          type: requestBody.Type
          company: requestBody.Company
          start: requestBody.StartFrom
          end: requestBody.EndTo
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a roster template
      effect: write
      questions:
      - Can I partially update a roster template's shifts?
      - What's the POST way to change a roster template?
      instructions:
      - text: Update roster template {id} with shifts {shifts} and total count {count}.
        slots:
          id: path.id
          shifts: requestBody.Shifts
          count: requestBody.TotalCount
      - text: Partially update roster template {id} with name {name}, type {type}, company {company}, {start} to {end}.
        slots:
          id: path.id
          name: requestBody.Name
          type: requestBody.Type
          company: requestBody.Company
          start: requestBody.StartFrom
          end: requestBody.EndTo
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a roster template
      effect: destructive
      questions:
      - Can I delete a roster template?
      - What removes a roster template record?
      instructions:
      - text: Delete roster template {id}.
        slots:
          id: path.id
      - text: Remove roster template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a roster template
      effect: read
      questions:
      - What comments have been left on a roster template?
      - Can I read the comment history of a roster template?
      instructions:
      - text: List comments on roster template {id}.
        slots:
          id: path.id
      - text: Show the comment history of roster template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a roster template
      effect: write
      questions:
      - Can I add a comment to a roster template?
      - How do I annotate a roster template with a note?
      instructions:
      - text: Add comment {comment} to roster template {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment roster template {id} with {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a roster template
      effect: destructive
      questions:
      - Can I delete a comment from a roster template?
      - What removes a single comment on a roster template?
      instructions:
      - text: Delete comment {commentId} from roster template {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove comment {commentId} on roster template {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a roster template's change history
      effect: read
      questions:
      - What changes have been made to a roster template over time?
      - Can I see the full edit history of a roster template?
      instructions:
      - text: Show the change history of roster template {id}.
        slots:
          id: path.id
      - text: List every edit made to roster template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/RosterTemplate/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: See a roster template as it was in the past
      effect: read
      questions:
      - How did a roster template look at a specific past time?
      - Can I roll back a roster template to how it was on a given date?
      instructions:
      - text: Get roster template {id} as it existed at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Show the old version of roster template {id} saved at {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.
All 92 tools →

Call it yourself

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