Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Area Profile API

8 actions 8 updates phrasing extends openapi/deputy-area-profile-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 8

$.info
$.paths['/management/v2/areas'].get
$.paths['/management/v2/areas'].post
$.paths['/management/v2/areas/employee:trained'].post
$.paths['/management/v2/areas/in-use'].post
$.paths['/management/v2/areas/{id}'].get
$.paths['/management/v2/areas/{id}'].put
$.paths['/management/v2/areas/{id}'].delete

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 Area Profile API
  version: 1.0.0
extends: openapi/deputy-area-profile-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: 7
- target: $.paths['/management/v2/areas'].get
  update:
    x-apievangelist-phrasing:
      intent: List areas
      effect: read
      questions:
      - Which areas exist in a location?
      - Can I list only active areas?
      instructions:
      - text: List areas matching {filters}.
        slots:
          filters: query.filters
      - text: List areas with active status {active}.
        slots:
          active: query.filters
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/areas'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an area
      effect: write
      questions:
      - How do I add a new area for a location?
      - Can I set an area's work type and export code when creating it?
      instructions:
      - text: Create area {name} at location {locationId}.
        slots:
          name: requestBody.name
          locationId: requestBody.locationId
      - text: Create area {name} with work type {workType} and export code {exportCode}.
        slots:
          name: requestBody.name
          workType: requestBody.workType
          exportCode: requestBody.exportCode
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/areas/employee:trained'].post
  update:
    x-apievangelist-phrasing:
      intent: List areas an employee is trained in
      effect: read
      questions:
      - Which areas has a given employee been trained in?
      - Can I filter the areas an employee is trained in to certain locations?
      instructions:
      - text: List areas employee {employeeId} is trained in.
        slots:
          employeeId: requestBody.employeeId
      - text: List areas employee {employeeId} is trained in at locations {locationIds}.
        slots:
          employeeId: requestBody.employeeId
          locationIds: requestBody.locationIds
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/areas/in-use'].post
  update:
    x-apievangelist-phrasing:
      intent: List areas used in timesheets or roster
      effect: read
      questions:
      - Which areas are currently in use on timesheets or the roster?
      - Can I check whether specific areas are in use?
      instructions:
      - text: List areas in use at locations {locationIds}.
        slots:
          locationIds: requestBody.locationIds
      - text: List areas {areaIds} that are in use.
        slots:
          areaIds: requestBody.areaIds
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/areas/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an area
      effect: read
      questions:
      - What are the details of one area?
      - Can I look up an area by its ID?
      instructions:
      - text: Get area {id}.
        slots:
          id: path.id
      - text: Show the details of area {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/areas/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an area
      effect: write
      questions:
      - How do I rename an existing area?
      - Can I deactivate an area or change its roster sort order?
      instructions:
      - text: Update area {id} to name {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set area {id} active status to {isActive}.
        slots:
          id: path.id
          isActive: requestBody.isActive
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/areas/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an area
      effect: destructive
      questions:
      - How do I delete an area?
      - Can I remove an area I no longer use?
      instructions:
      - text: Delete area {id}.
        slots:
          id: path.id
      - text: Remove area {id} permanently.
        slots:
          id: path.id
      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-area-profile-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.