Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Employee Agreement Area Rate API

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

$.info
$.paths['/resource/EmployeeAgreementAreaRate'].get
$.paths['/resource/EmployeeAgreementAreaRate/INFO'].get
$.paths['/resource/EmployeeAgreementAreaRate/PREDICT'].post
$.paths['/resource/EmployeeAgreementAreaRate/QUERY'].post
$.paths['/resource/EmployeeAgreementAreaRate/{id}'].get
$.paths['/resource/EmployeeAgreementAreaRate/{id}/COMMENTS'].get
$.paths['/resource/EmployeeAgreementAreaRate/{id}/COMMENTS'].post
$.paths['/resource/EmployeeAgreementAreaRate/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmployeeAgreementAreaRate/{id}/HISTORY'].get
$.paths['/resource/EmployeeAgreementAreaRate/{id}/HISTORY/travel/{timestamp}'].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 Employee Agreement Area Rate API
  version: 1.0.0
extends: openapi/deputy-employeeagreementarearate-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: 10
- target: $.paths['/resource/EmployeeAgreementAreaRate'].get
  update:
    x-apievangelist-phrasing:
      intent: List area rates on employee agreements
      effect: read
      questions:
      - Which area rates are set on an employee's agreement?
      - Can I see all agreement area rates?
      instructions:
      - text: List all employee agreement area rates.
      - text: Show every area rate on employee agreements.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementAreaRate/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get field metadata for agreement area rates
      effect: read
      questions:
      - What fields and types does an agreement area rate record have?
      - Which fields can I search on for employee agreement area rates?
      instructions:
      - text: Show the field metadata for employee agreement area rates.
      - text: List the fields and types of agreement area rate records.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementAreaRate/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing agreement area rate
      effect: read
      questions:
      - Can I find an existing area rate record for an employee agreement?
      - How do I match a partial agreement area rate to an existing record?
      instructions:
      - text: Find the existing area rate record for agreement {EmployeeAgreementId} on {OperationalUnitId} with contract {ContractId}.
        slots:
          EmployeeAgreementId: requestBody.EmployeeAgreementId
          OperationalUnitId: requestBody.OperationalUnitId
          ContractId: requestBody.ContractId
      - text: Predict-match an area rate for agreement {EmployeeAgreementId} on {OperationalUnitId} with contract {ContractId} at base rate {BaseRate}.
        slots:
          EmployeeAgreementId: requestBody.EmployeeAgreementId
          OperationalUnitId: requestBody.OperationalUnitId
          ContractId: requestBody.ContractId
          BaseRate: requestBody.BaseRate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementAreaRate/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee agreement area rates
      effect: read
      questions:
      - Can I search employee agreement area rates by contract?
      - How do I sort agreement area rates?
      instructions:
      - text: Search employee agreement area rates matching {search}.
        slots:
          search: requestBody.search
      - text: Find agreement area rates sorted by {sort}.
        slots:
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementAreaRate/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agreement area rate
      effect: read
      questions:
      - What base rate is set on a specific agreement area rate?
      - Can I fetch one employee agreement area rate by id?
      instructions:
      - text: Get agreement area rate {id}.
        slots:
          id: path.id
      - text: Show the base rate on area rate {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementAreaRate/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on an agreement area rate
      effect: read
      questions:
      - What comments have been left on an agreement area rate?
      - Can I read the notes on an area rate record?
      instructions:
      - text: List comments on agreement area rate {id}.
        slots:
          id: path.id
      - text: Show the notes on area rate {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementAreaRate/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to an agreement area rate
      effect: write
      questions:
      - Can I add a note to an agreement area rate?
      - How do I comment on an area rate record?
      instructions:
      - text: Add comment {Comment} to agreement area rate {id}.
        slots:
          Comment: requestBody.Comment
          id: path.id
      - text: Comment {Comment} on area rate {id}.
        slots:
          Comment: requestBody.Comment
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementAreaRate/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment from an agreement area rate
      effect: destructive
      questions:
      - Can I delete a comment on an agreement area rate?
      - How do I remove a note from an area rate record?
      instructions:
      - text: Delete comment {commentId} from agreement area rate {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove note {commentId} on area rate {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementAreaRate/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of an agreement area rate
      effect: read
      questions:
      - Who changed an agreement area rate and when?
      - Can I see the change history of an area rate?
      instructions:
      - text: Show the change history of agreement area rate {id}.
        slots:
          id: path.id
      - text: List the edits made to area rate {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAgreementAreaRate/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: See an agreement area rate as it was at a past time
      effect: read
      questions:
      - What did an agreement area rate look like at a specific time?
      - Can I travel back to an area rate record as it was yesterday?
      instructions:
      - text: Show agreement area rate {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to area rate {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-employeeagreementarearate-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.