Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Pay Rules API

17 actions 17 updates phrasing extends openapi/deputy-payrules-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/PayRules'].get
$.paths['/resource/PayRules'].put
$.paths['/resource/PayRules'].post
$.paths['/resource/PayRules/BULK'].post
$.paths['/resource/PayRules/INFO'].get
$.paths['/resource/PayRules/PREDICT'].post
$.paths['/resource/PayRules/QUERY'].post
$.paths['/resource/PayRules/{id}'].get
$.paths['/resource/PayRules/{id}'].put
$.paths['/resource/PayRules/{id}'].post
$.paths['/resource/PayRules/{id}'].delete
$.paths['/resource/PayRules/{id}/COMMENTS'].get
$.paths['/resource/PayRules/{id}/COMMENTS'].post
$.paths['/resource/PayRules/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/PayRules/{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 Pay Rules API
  version: 1.0.0
extends: openapi/deputy-payrules-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/PayRules'].get
  update:
    x-apievangelist-phrasing:
      intent: List pay rules
      effect: read
      questions:
      - What pay rules apply to my staff?
      - Where can I get a list of pay rules?
      instructions:
      - text: List all pay rules.
      - text: Show me the pay rules record for a job.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a pay rule
      effect: write
      questions:
      - How do I create a pay rule that pays an hourly rate?
      - Can I replace an existing pay rule with a new one?
      instructions:
      - text: Create pay rule {title} with {type} paid {by} at {rate}.
        slots:
          title: requestBody.PayTitle
          type: requestBody.RemunerationType
          by: requestBody.RemunerationBy
          rate: requestBody.HourlyRate
      - text: Replace pay rule {title} with an annual salary of {salary}.
        slots:
          title: requestBody.PayTitle
          salary: requestBody.AnnualSalary
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pay rule
      effect: write
      questions:
      - Can I add a new pay rule for a specific pay title?
      - What fields are required to create a pay rule?
      instructions:
      - text: Create a new pay rule titled {title} with {type} paid {by}.
        slots:
          title: requestBody.PayTitle
          type: requestBody.RemunerationType
          by: requestBody.RemunerationBy
      - text: Add a pay rule {title} for {type} paid {by} at {rate}.
        slots:
          title: requestBody.PayTitle
          type: requestBody.RemunerationType
          by: requestBody.RemunerationBy
          rate: requestBody.HourlyRate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many pay rules
      effect: write
      questions:
      - Can I create several pay rules in one request?
      - How do I update a batch of pay rules at once?
      instructions:
      - text: Bulk create or update these pay rules.
      - text: Apply this batch of pay rule changes.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get pay rule field metadata
      effect: read
      questions:
      - Which fields can I search on when looking up pay rules?
      - What field types and associations does the pay rules resource have?
      instructions:
      - text: Show the field metadata for pay rules.
      - text: List the searchable fields on pay rules.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing pay rule
      effect: read
      questions:
      - Can I find the existing pay rule that matches a partial pay rule?
      - What pay rule already exists for a given pay title and remuneration type?
      instructions:
      - text: Predict the existing pay rule for {title} with {type} paid {by}.
        slots:
          title: requestBody.PayTitle
          type: requestBody.RemunerationType
          by: requestBody.RemunerationBy
      - text: Match this partial pay rule to an existing one.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search pay rules
      effect: read
      questions:
      - Can I search pay rules by pay title or remuneration type?
      - How do I sort and page through pay rules?
      instructions:
      - text: Search pay rules where {field} is {value}.
        slots:
          field: requestBody.search
          value: requestBody.search
      - text: Find pay rules matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pay rule
      effect: read
      questions:
      - What are the settings of one pay rule?
      - Can I fetch a single pay rule by its id?
      instructions:
      - text: Get pay rule {id}.
        slots:
          id: path.id
      - text: Show the details of pay rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a pay rule (PUT)
      effect: write
      questions:
      - Can I update a pay rule's hourly rate with a PUT request?
      - What does a full pay rule update require?
      instructions:
      - text: Update pay rule {id} with title {title}, type {type}, paid {by}, rate {rate}.
        slots:
          id: path.id
          title: requestBody.PayTitle
          type: requestBody.RemunerationType
          by: requestBody.RemunerationBy
          rate: requestBody.HourlyRate
      - text: Replace pay rule {id} in full.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a pay rule (POST)
      effect: write
      questions:
      - Can I change a pay rule's settings with a POST request?
      - Is there a POST endpoint for partial updates to a pay rule?
      instructions:
      - text: POST an update to pay rule {id} changing its title to {title}.
        slots:
          id: path.id
          title: requestBody.PayTitle
      - text: Send a partial pay rule update to {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pay rule
      effect: destructive
      questions:
      - Can I delete a pay rule?
      - What removes a pay rule from the system?
      instructions:
      - text: Delete pay rule {id}.
        slots:
          id: path.id
      - text: Remove the pay rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a pay rule
      effect: read
      questions:
      - What comments have been left on a pay rule?
      - Can I see the comment history for a pay rule?
      instructions:
      - text: List comments on pay rule {id}.
        slots:
          id: path.id
      - text: Show the comment history for pay rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a pay rule
      effect: write
      questions:
      - Can I add a comment to a pay rule?
      - How do I annotate a pay rule with a note?
      instructions:
      - text: Add comment {comment} to pay rule {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment pay rule {id} saying {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a pay rule
      effect: destructive
      questions:
      - Can I delete a comment on a pay rule?
      - What removes a single comment from a pay rule?
      instructions:
      - text: Delete comment {commentId} from pay rule {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove comment {commentId} on pay rule {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of a pay rule
      effect: read
      questions:
      - What changes have been made to a pay rule over time?
      - Can I see the edit history of a pay rule?
      instructions:
      - text: Show the change history of pay rule {id}.
        slots:
          id: path.id
      - text: List every edit made to pay rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/PayRules/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pay rule as it was at a past time
      effect: read
      questions:
      - Can I see what a pay rule looked like at a specific point in the past?
      - What did a pay rule contain before its last edit?
      instructions:
      - text: Show pay rule {id} as it existed at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to pay rule {id} at {timestamp}.
        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-payrules-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.