Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Employee Role API

11 actions 11 updates phrasing extends openapi/deputy-employeerole-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/EmployeeRole'].get
$.paths['/resource/EmployeeRole/INFO'].get
$.paths['/resource/EmployeeRole/PREDICT'].post
$.paths['/resource/EmployeeRole/QUERY'].post
$.paths['/resource/EmployeeRole/{id}'].get
$.paths['/resource/EmployeeRole/{id}/COMMENTS'].get
$.paths['/resource/EmployeeRole/{id}/COMMENTS'].post
$.paths['/resource/EmployeeRole/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmployeeRole/{id}/HISTORY'].get
$.paths['/resource/EmployeeRole/{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 Role API
  version: 1.0.0
extends: openapi/deputy-employeerole-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/EmployeeRole'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee roles
      effect: read
      questions:
      - Which employee roles exist in Deputy?
      - Can I page through all employee roles?
      instructions:
      - text: List all employee roles.
      - text: Show every employee role record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeRole/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employee role field metadata
      effect: read
      questions:
      - What fields and permissions does an employee role have?
      - Which employee role fields can I query?
      instructions:
      - text: Show the field metadata for employee roles.
      - text: List the queryable employee role fields.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeRole/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing employee role
      effect: read
      questions:
      - How do I find an existing employee role before creating one?
      - Can I match a role by its id, role name and ranking?
      instructions:
      - text: Find the employee role with id {id}, role {role} and ranking {ranking}.
        slots:
          id: requestBody.Id
          role: requestBody.Role
          ranking: requestBody.Ranking
      - text: Match an existing employee role using {id}, {role}, {ranking} and {modified}.
        slots:
          id: requestBody.Id
          role: requestBody.Role
          ranking: requestBody.Ranking
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeRole/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee roles
      effect: read
      questions:
      - Can I search employee roles by role name or ranking?
      - Is there a way to sort employee roles by ranking?
      instructions:
      - text: Search employee roles matching {search}.
        slots:
          search: requestBody.search
      - text: Find employee roles sorted by {sort}.
        slots:
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeRole/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee role
      effect: read
      questions:
      - What are the details of one employee role?
      - Can I look up an employee role by id?
      instructions:
      - text: Get employee role {id}.
        slots:
          id: path.id
      - text: Show the employee role record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeRole/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on an employee role
      effect: read
      questions:
      - What comments have been left on an employee role?
      - Can I read the comment history of a role?
      instructions:
      - text: List comments on employee role {id}.
        slots:
          id: path.id
      - text: Show the comment history of employee role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeRole/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on an employee role
      effect: write
      questions:
      - How do I leave a comment on an employee role?
      - Can I annotate a role with a note?
      instructions:
      - text: Comment {comment} on employee role {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Add a note {comment} to employee role {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeRole/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on an employee role
      effect: destructive
      questions:
      - Can I remove a comment from an employee role?
      - Is deleting a role comment permanent?
      instructions:
      - text: Delete comment {commentId} from employee role {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove the comment {commentId} on role {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeRole/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of an employee role
      effect: read
      questions:
      - Who changed an employee role and when?
      - Can I see the change history of a role?
      instructions:
      - text: Show the change history of employee role {id}.
        slots:
          id: path.id
      - text: List the edits made to employee role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeRole/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: See an employee role as it was at a past time
      effect: read
      questions:
      - Can I see how an employee role looked at a past moment?
      - What did a role's details look like at a given timestamp?
      instructions:
      - text: Show employee role {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel to employee role {id} at {timestamp} and show it.
        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-employeerole-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.