Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Deputy Reports API

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

$.info
$.paths['/management/v2/reports/RS_TS_VARIANCE/export'].post
$.paths['/management/v2/reports/report'].post
$.paths['/management/v2/reports/url/{reportType}/{id}'].post
$.paths['/management/v2/reports/{reportType}'].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 Deputy Reports API
  version: 1.0.0
extends: openapi/deputy-deputy-reports-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: 4
- target: $.paths['/management/v2/reports/RS_TS_VARIANCE/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export schedule vs timesheet vs sales variance
      effect: write
      questions:
      - How do I compare scheduled hours against actual timesheets and sales?
      - Can I run a schedule vs timesheet vs sales variance report for certain locations?
      instructions:
      - text: Export the schedule vs timesheet vs sales variance report.
      - text: Run a schedule vs timesheet vs sales variance report for locations {locationIds} from {startDate} to {endDate}.
        slots:
          locationIds: requestBody.locationIds
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/report'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a schedule vs timesheet vs sales report
      effect: write
      questions:
      - Can I create a report that compares schedules, timesheets and sales?
      - Is it possible to include FWW pay premiums and shift change consent in a new report?
      instructions:
      - text: Create a schedule vs timesheet vs sales report named {name}.
        slots:
          name: requestBody.name
      - text: Create a report {name} covering {startDate} to {endDate} with FWW pay premiums {fwwPayPremiums}.
        slots:
          name: requestBody.name
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          fwwPayPremiums: requestBody.fwwPayPremiums
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/url/{reportType}/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a URL for a report
      effect: read
      questions:
      - How do I get a link to a generated report?
      - Can I fetch a report URL by its type and ID?
      instructions:
      - text: Get the URL for {reportType} report {id}.
        slots:
          reportType: path.reportType
          id: path.id
      - text: Fetch a link to {reportType} report {id}.
        slots:
          reportType: path.reportType
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/{reportType}'].get
  update:
    x-apievangelist-phrasing:
      intent: List reports of a type
      effect: read
      questions:
      - What reports of a given type are available?
      - Can I filter the list of reports?
      instructions:
      - text: List {reportType} reports.
        slots:
          reportType: path.reportType
      - text: List {reportType} reports matching {filters}.
        slots:
          reportType: path.reportType
          filters: query.filters
      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-deputy-reports-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.