Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Compliance API

25 actions 25 updates phrasing extends openapi/deputy-compliance-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 25 · first 16 shown; the file carries all of them

$.info
$.paths['/management/v2/compliance/awards'].get
$.paths['/management/v2/compliance/calculation-types'].get
$.paths['/management/v2/compliance/contract'].get
$.paths['/management/v2/compliance/contract'].post
$.paths['/management/v2/compliance/contract-config:batch-save'].post
$.paths['/management/v2/compliance/contract-pay-rule-ordering'].post
$.paths['/management/v2/compliance/contract/{id}'].get
$.paths['/management/v2/compliance/contract/{id}'].put
$.paths['/management/v2/compliance/contract/{id}/employees'].get
$.paths['/management/v2/compliance/contract:duplicate'].post
$.paths['/management/v2/compliance/contract:export-json'].get
$.paths['/management/v2/compliance/contract:import-json'].post
$.paths['/management/v2/compliance/contract:update-json'].post
$.paths['/management/v2/compliance/contracts/{contractId}/leave-rules'].post
$.paths['/management/v2/compliance/contracts/{contractId}/leave-rules/{leaveRuleId}'].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 Compliance API
  version: 1.0.0
extends: openapi/deputy-compliance-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: 24
- target: $.paths['/management/v2/compliance/awards'].get
  update:
    x-apievangelist-phrasing:
      intent: List awards
      effect: read
      questions:
      - What awards are set up for compliance?
      - Can I see all awards?
      instructions:
      - text: List awards.
      - text: Show every award configured.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/calculation-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List calculation types
      effect: read
      questions:
      - What calculation types exist for a country?
      - Can I include global calculation types?
      instructions:
      - text: List calculation types for {country}.
        slots:
          country: query.country
      - text: 'Show calculation types including global ones: {includeGlobal}.'
        slots:
          includeGlobal: query.includeGlobal
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contract'].get
  update:
    x-apievangelist-phrasing:
      intent: List contracts
      effect: read
      questions:
      - Which contracts are set up for compliance?
      - Can I filter contracts by title or status?
      instructions:
      - text: List contracts titled {title}.
        slots:
          title: query.title
      - text: Show contracts with status {statuses}.
        slots:
          statuses: query.statuses
      - text: Show the next page of contracts after {pageToken}.
        slots:
          pageToken: query.pageToken
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contract'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contract
      effect: write
      questions:
      - How do I create a new contract?
      - Can I add a contract for a country's pay rules?
      instructions:
      - text: Create a contract.
      - text: Add a new compliance contract.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contract-config:batch-save'].post
  update:
    x-apievangelist-phrasing:
      intent: Save many contract configs at once
      effect: write
      questions:
      - Can I save several contract configurations in one call?
      - Is there a batch save for contract configs?
      instructions:
      - text: Batch save contract configs {configs}.
        slots:
          configs: requestBody.configs
      - text: Save contract configs {configs} with confirm customisation {confirmCustomisation}.
        slots:
          configs: requestBody.configs
          confirmCustomisation: requestBody.confirmCustomisation
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contract-pay-rule-ordering'].post
  update:
    x-apievangelist-phrasing:
      intent: Save the pay rule order on a contract
      effect: write
      questions:
      - How do I change the order pay rules are applied on a contract?
      - Can I reorder pay rules for a contract?
      instructions:
      - text: Save pay rule order {payRuleIds} on contract {contractId}.
        slots:
          payRuleIds: requestBody.payRuleIds
          contractId: requestBody.contractId
      - text: Reorder contract {contractId} pay rules to {payRuleIds}.
        slots:
          contractId: requestBody.contractId
          payRuleIds: requestBody.payRuleIds
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contract/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract
      effect: read
      questions:
      - What pay rules and standard hours does a contract have?
      - Can I look up one contract by id?
      instructions:
      - text: Get contract {id}.
        slots:
          id: path.id
      - text: Show the pay rules and standard hours on contract {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contract/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contract
      effect: write
      questions:
      - How do I change a contract's employment type or base pay rule?
      - Can I set standard hours per day on a contract?
      instructions:
      - text: Set contract {id} employment type to {employmentType}.
        slots:
          id: path.id
          employmentType: requestBody.employmentType
      - text: Change contract {id} base pay rule to {basePayRule}.
        slots:
          id: path.id
          basePayRule: requestBody.basePayRule
      - text: Set contract {id} standard hours to {standardHours}.
        slots:
          id: path.id
          standardHours: requestBody.standardHours
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contract/{id}/employees'].get
  update:
    x-apievangelist-phrasing:
      intent: List employees on a contract
      effect: read
      questions:
      - Which employees are on a given contract?
      - Can I see everyone assigned to a contract?
      instructions:
      - text: List employees on contract {id}.
        slots:
          id: path.id
      - text: Show who works under contract {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contract:duplicate'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a contract
      effect: write
      questions:
      - How do I copy an existing contract?
      - Can I make a duplicate of a contract?
      instructions:
      - text: Duplicate a contract.
      - text: Make a copy of this contract.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contract:export-json'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a contract as JSON
      effect: read
      questions:
      - Can I export a contract as JSON?
      - What does a contract look like as JSON?
      instructions:
      - text: Export contract {id} as JSON.
        slots:
          id: query.id
      - text: Download contract {id} in JSON format.
        slots:
          id: query.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contract:import-json'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a contract from JSON
      effect: write
      questions:
      - How do I import a contract from JSON?
      - Can I load a contract definition from JSON?
      instructions:
      - text: Import contract JSON {data}.
        slots:
          data: requestBody.data
      - text: Load a contract from JSON {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contract:update-json'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a contract from JSON
      effect: write
      questions:
      - Can I update a contract by sending its JSON?
      - Is there a JSON update for contracts?
      instructions:
      - text: Update a contract from JSON {data}.
        slots:
          data: requestBody.data
      - text: Apply contract JSON {data} to the existing contract.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contracts/{contractId}/leave-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Associate leave rules with a contract
      effect: write
      questions:
      - How do I attach leave rules to a contract?
      - Can I link several leave rules to one contract?
      instructions:
      - text: Associate leave rules {leaveRuleIds} with contract {contractId}.
        slots:
          leaveRuleIds: requestBody.leaveRuleIds
          contractId: path.contractId
      - text: Link leave rules {leaveRuleIds} to contract {contractId}.
        slots:
          leaveRuleIds: requestBody.leaveRuleIds
          contractId: path.contractId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contracts/{contractId}/leave-rules/{leaveRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassociate a leave rule from a contract
      effect: destructive
      questions:
      - How do I remove a leave rule from a contract?
      - Can I unlink one leave rule from a contract?
      instructions:
      - text: Unassociate leave rule {leaveRuleId} from contract {contractId}.
        slots:
          leaveRuleId: path.leaveRuleId
          contractId: path.contractId
      - text: Remove leave rule {leaveRuleId} from contract {contractId}.
        slots:
          leaveRuleId: path.leaveRuleId
          contractId: path.contractId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/contracts/{contractId}/payrules/{payRuleId}/association'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassociate a pay rule from a contract
      effect: destructive
      questions:
      - How do I remove a pay rule from a contract?
      - Can I unlink one pay rule from a contract?
      instructions:
      - text: Unassociate pay rule {payRuleId} from contract {contractId}.
        slots:
          payRuleId: path.payRuleId
          contractId: path.contractId
      - text: Remove pay rule {payRuleId} from contract {contractId}.
        slots:
          payRuleId: path.payRuleId
          contractId: path.contractId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/employee-rates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employee rates for a contract
      effect: read
      questions:
      - What hourly rates do employees on a contract earn?
      - Can I see employee rates for one contract?
      instructions:
      - text: Get employee rates for contract {contractId}.
        slots:
          contractId: query.contractId
      - text: Show hourly rates for employees on contract {contractId}.
        slots:
          contractId: query.contractId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/employee-rates'].put
  update:
    x-apievangelist-phrasing:
      intent: Update employee rates
      effect: write
      questions:
      - How do I change the hourly rates for employees on a contract?
      - Can I bulk update employee rates?
      instructions:
      - text: Update employee rates with {data}.
        slots:
          data: requestBody.data
      - text: Apply the employee rate changes {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/junior-rate:update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update the junior rate
      effect: write
      questions:
      - How do I change the junior rate?
      - Can I update the junior rate for a country?
      instructions:
      - text: Update the junior rate.
      - text: Change the junior rate to the new value.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/leave-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List leave rules
      effect: read
      questions:
      - What leave rules are available?
      - Can I see all leave rules?
      instructions:
      - text: List leave rules.
      - text: Show every leave rule.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/pay-policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List pay policies
      effect: read
      questions:
      - What pay policies are configured for a country?
      - Can I include the global pay policy when listing pay policies?
      instructions:
      - text: List pay policies for {country}.
        slots:
          country: query.country
      - text: Show all pay policies including the global one.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/pay-policies/{ppId}/latest-version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest version of a pay policy
      effect: read
      questions:
      - What is the most recent version of a pay policy?
      - Can I check the latest pay policy version by its ID?
      instructions:
      - text: Get the latest version of pay policy {ppId}.
        slots:
          ppId: path.ppId
      - text: Show the newest version of pay policy {ppId}.
        slots:
          ppId: path.ppId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/pay-rule:batch-save'].post
  update:
    x-apievangelist-phrasing:
      intent: Save several pay rules at once
      effect: write
      questions:
      - Can I save many pay rules in one request?
      - Is it possible to confirm customisations when saving pay rules?
      instructions:
      - text: Save pay rules {payRules} for contract {contractId}.
        slots:
          payRules: requestBody.payRules
          contractId: requestBody.contractId
      - text: Save pay rules {payRules} with confirm customisation {confirmCustomisation}.
        slots:
          payRules: requestBody.payRules
          confirmCustomisation: requestBody.confirmCustomisation
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/compliance/payrules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pay rule
      effect: destructive
      questions:
      - How do I remove a pay rule?
      - Can I delete a pay rule by its ID?
      instructions:
      - text: Delete pay rule {id}.
        slots:
          id: path.id
      - text: Remove the pay rule with ID {id}.
        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-compliance-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.