Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Swaps API

7 actions 7 updates phrasing extends openapi/deputy-swaps-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 7

$.info
$.paths['/management/v2/shifts/swap/pending-approvals'].post
$.paths['/management/v2/shifts/swap:confirm'].post
$.paths['/management/v2/shifts/swap:decline'].post
$.paths['/management/v2/shifts/swap:recommendation'].post
$.paths['/management/v2/shifts/{shiftId}/swap/pending'].get
$.paths['/me/v2/shifts/swap:pending'].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 V2 Swaps API
  version: 1.0.0
extends: openapi/deputy-swaps-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: 6
- target: $.paths['/management/v2/shifts/swap/pending-approvals'].post
  update:
    x-apievangelist-phrasing:
      intent: List shift swaps pending approval
      effect: read
      questions:
      - Which shift swaps are waiting for my approval?
      - Can I filter pending shift swaps by location?
      instructions:
      - text: List pending shift swaps.
      - text: Show pending swaps for locations {locationIds}.
        slots:
          locationIds: requestBody.locationIds
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/shifts/swap:confirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm and execute shift swaps
      effect: write
      questions:
      - How do I swap two employees between shifts?
      - Can I test a shift swap first before committing it?
      instructions:
      - text: Confirm swaps between shifts {sourceShiftIds} and {targetShiftIds}.
        slots:
          sourceShiftIds: requestBody.sourceShiftIds
          targetShiftIds: requestBody.targetShiftIds
      - text: Test swap {sourceShiftIds} and {targetShiftIds} with trial set to {trial}.
        slots:
          sourceShiftIds: requestBody.sourceShiftIds
          targetShiftIds: requestBody.targetShiftIds
          trial: requestBody.trial
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/shifts/swap:decline'].post
  update:
    x-apievangelist-phrasing:
      intent: Decline pending shift swaps
      effect: destructive
      questions:
      - How do I turn down a shift swap request?
      - Can I leave a message when declining a swap?
      instructions:
      - text: Decline swap requests between shifts {sourceShiftIds} and {targetShiftIds}.
        slots:
          sourceShiftIds: requestBody.sourceShiftIds
          targetShiftIds: requestBody.targetShiftIds
      - text: Decline swaps {sourceShiftIds} and {targetShiftIds} with the message {message}.
        slots:
          sourceShiftIds: requestBody.sourceShiftIds
          targetShiftIds: requestBody.targetShiftIds
          message: requestBody.message
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/shifts/swap:recommendation'].post
  update:
    x-apievangelist-phrasing:
      intent: Get shift swap recommendations
      effect: read
      questions:
      - Who could swap shifts with a given employee?
      - Can I see swap partners for several shifts at once?
      instructions:
      - text: Get swap recommendations for shifts {shiftIds}.
        slots:
          shiftIds: requestBody.shiftIds
      - text: Recommend swaps for employees {employeeIds} on shifts {shiftIds}.
        slots:
          employeeIds: requestBody.employeeIds
          shiftIds: requestBody.shiftIds
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/shifts/{shiftId}/swap/pending'].get
  update:
    x-apievangelist-phrasing:
      intent: Get pending swap requests for a shift
      effect: read
      questions:
      - What swap requests are pending for one shift?
      - Who asked to swap shifts with a particular shift?
      instructions:
      - text: Show pending swap details for shift {shiftId}.
        slots:
          shiftId: path.shiftId
      - text: List swap requests involving shift {shiftId}.
        slots:
          shiftId: path.shiftId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/me/v2/shifts/swap:pending'].get
  update:
    x-apievangelist-phrasing:
      intent: List my pending shift swaps
      effect: read
      questions:
      - Which shift swaps am I waiting on?
      - Can I see pending swaps for a date range?
      instructions:
      - text: List my pending shift swaps.
      - text: Show my pending swaps between {start} and {end}.
        slots:
          start: query.start
          end: query.end
      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-swaps-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.