Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Task Group API

17 actions 17 updates phrasing extends openapi/deputy-taskgroup-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/TaskGroup'].get
$.paths['/resource/TaskGroup'].put
$.paths['/resource/TaskGroup'].post
$.paths['/resource/TaskGroup/BULK'].post
$.paths['/resource/TaskGroup/INFO'].get
$.paths['/resource/TaskGroup/PREDICT'].post
$.paths['/resource/TaskGroup/QUERY'].post
$.paths['/resource/TaskGroup/{id}'].get
$.paths['/resource/TaskGroup/{id}'].put
$.paths['/resource/TaskGroup/{id}'].post
$.paths['/resource/TaskGroup/{id}'].delete
$.paths['/resource/TaskGroup/{id}/COMMENTS'].get
$.paths['/resource/TaskGroup/{id}/COMMENTS'].post
$.paths['/resource/TaskGroup/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/TaskGroup/{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 Task Group API
  version: 1.0.0
extends: openapi/deputy-taskgroup-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/TaskGroup'].get
  update:
    x-apievangelist-phrasing:
      intent: List task groups
      effect: read
      questions:
      - What task groups exist in my Deputy account?
      - Can I page through all task groups?
      instructions:
      - text: List all task groups.
      - text: Show every task group record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a task group (PUT)
      effect: write
      questions:
      - How do I create a task group with a PUT request?
      - Can I replace a task group by sending its full record in a PUT?
      instructions:
      - text: Create task group {key} for {date} at {day_timestamp} in unit {unit_id}.
        slots:
          key: requestBody.Key
          date: requestBody.Date
          day_timestamp: requestBody.DayTimestamp
          unit_id: requestBody.OpUnitId
      - text: PUT a new task group record with name {name}, setup {setup_id}, creator {creator}, created {created}, modified {modified}.
        slots:
          name: requestBody.Name
          setup_id: requestBody.GroupSetupId
          creator: requestBody.Creator
          created: requestBody.Created
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task group (POST)
      effect: write
      questions:
      - How do I create a task group with a POST request?
      - Can I add a new task group without replacing existing ones?
      instructions:
      - text: POST a new task group named {name} for {date} at {day_timestamp} in unit {unit_id}.
        slots:
          name: requestBody.Name
          date: requestBody.Date
          day_timestamp: requestBody.DayTimestamp
          unit_id: requestBody.OpUnitId
      - text: Create a task group with key {key}, setup {setup_id}, creator {creator}, created {created}, modified {modified}.
        slots:
          key: requestBody.Key
          setup_id: requestBody.GroupSetupId
          creator: requestBody.Creator
          created: requestBody.Created
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many task groups at once
      effect: write
      questions:
      - Can I create or update several task groups in one request?
      - How do I bulk upsert task groups?
      instructions:
      - text: Bulk create or update these task groups.
      - text: Upsert this batch of task group records.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get task group field metadata
      effect: read
      questions:
      - Which fields are queryable on task groups?
      - What types and associations does the task group resource have?
      instructions:
      - text: Get the field metadata for task groups.
      - text: Show which task group fields can be searched.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing task group by partial data
      effect: read
      questions:
      - How do I find the existing task group that matches a partial record?
      - Can I predict a task group before creating it?
      instructions:
      - text: Predict the task group matching {key} for {date} at {day_timestamp} in unit {unit_id}.
        slots:
          key: requestBody.Key
          date: requestBody.Date
          day_timestamp: requestBody.DayTimestamp
          unit_id: requestBody.OpUnitId
      - text: Find the existing task group for setup {setup_id}, name {name}, creator {creator}, created {created}, modified {modified}.
        slots:
          setup_id: requestBody.GroupSetupId
          name: requestBody.Name
          creator: requestBody.Creator
          created: requestBody.Created
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search task groups
      effect: read
      questions:
      - Can I search task groups by a field and sort the results?
      - How do I find task groups matching a date range?
      instructions:
      - text: Search task groups where {search}.
        slots:
          search: requestBody.search
      - text: Find task groups matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task group by id
      effect: read
      questions:
      - What are the details of one task group?
      - Can I fetch a single task group by its id?
      instructions:
      - text: Get task group {id}.
        slots:
          id: path.id
      - text: Show the task group record with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a task group (PUT)
      effect: write
      questions:
      - How do I fully replace a task group's record with a PUT request?
      - Can I overwrite a task group's name and date in one PUT?
      instructions:
      - text: Replace task group {id} with name {name}, date {date}, setup {setup_id}, creator {creator}, created {created}, modified {modified}.
        slots:
          id: path.id
          name: requestBody.Name
          date: requestBody.Date
          setup_id: requestBody.GroupSetupId
          creator: requestBody.Creator
          created: requestBody.Created
          modified: requestBody.Modified
      - text: PUT a full task group record {id} for unit {unit_id}.
        slots:
          id: path.id
          unit_id: requestBody.OpUnitId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a task group (POST)
      effect: write
      questions:
      - How do I update a task group with a POST request?
      - Can I change a task group's comment or labor model?
      instructions:
      - text: POST an update to task group {id} setting name {name}, date {date}, setup {setup_id}, creator {creator}, created {created}, modified {modified}.
        slots:
          id: path.id
          name: requestBody.Name
          date: requestBody.Date
          setup_id: requestBody.GroupSetupId
          creator: requestBody.Creator
          created: requestBody.Created
          modified: requestBody.Modified
      - text: Update task group {id} with comment {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task group
      effect: destructive
      questions:
      - How do I delete a task group?
      - Can I remove a task group record by id?
      instructions:
      - text: Delete task group {id}.
        slots:
          id: path.id
      - text: Remove the task group record with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a task group
      effect: read
      questions:
      - What comments have been left on a task group?
      - Can I read the comment history of a task group?
      instructions:
      - text: List comments on task group {id}.
        slots:
          id: path.id
      - text: Show the comment history of task group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a task group
      effect: write
      questions:
      - How do I add a comment to a task group?
      - Can I annotate a task group with a note?
      instructions:
      - text: Add comment {comment} to task group {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment on task group {id} saying {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a task group
      effect: destructive
      questions:
      - How do I delete a comment from a task group?
      - Can I remove one comment on a task group?
      instructions:
      - text: Delete comment {commentId} from task group {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove the comment {commentId} on task group {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task group's change history
      effect: read
      questions:
      - What changes have been made to a task group over time?
      - Can I see the edit history of a task group?
      instructions:
      - text: Show the change history of task group {id}.
        slots:
          id: path.id
      - text: List every edit made to task group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroup/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a task group as it was at a past time
      effect: read
      questions:
      - How do I see what a task group looked like at a past moment?
      - Can I travel back to a task group's state at a given timestamp?
      instructions:
      - text: Show task group {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to task group {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-taskgroup-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.