Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Employee Appraisal API

17 actions 17 updates phrasing extends openapi/deputy-employeeappraisal-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/EmployeeAppraisal'].get
$.paths['/resource/EmployeeAppraisal'].put
$.paths['/resource/EmployeeAppraisal'].post
$.paths['/resource/EmployeeAppraisal/BULK'].post
$.paths['/resource/EmployeeAppraisal/INFO'].get
$.paths['/resource/EmployeeAppraisal/PREDICT'].post
$.paths['/resource/EmployeeAppraisal/QUERY'].post
$.paths['/resource/EmployeeAppraisal/{id}'].get
$.paths['/resource/EmployeeAppraisal/{id}'].put
$.paths['/resource/EmployeeAppraisal/{id}'].post
$.paths['/resource/EmployeeAppraisal/{id}'].delete
$.paths['/resource/EmployeeAppraisal/{id}/COMMENTS'].get
$.paths['/resource/EmployeeAppraisal/{id}/COMMENTS'].post
$.paths['/resource/EmployeeAppraisal/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmployeeAppraisal/{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 Employee Appraisal API
  version: 1.0.0
extends: openapi/deputy-employeeappraisal-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/EmployeeAppraisal'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee appraisal records
      effect: read
      questions:
      - How do I see all employee appraisals I can access?
      - Can I page through the employee appraisal table?
      instructions:
      - text: List my employee appraisal records.
      - text: Show every employee appraisal record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace an employee appraisal
      effect: write
      questions:
      - Can I upsert an employee appraisal for a day by putting it to the collection endpoint?
      - What marks are required when creating an appraisal for an employee via PUT?
      instructions:
      - text: Put an appraisal for {employee} on {date} with first mark {mark1} and last mark {mark5}.
        slots:
          employee: requestBody.Employee
          date: requestBody.Date
          mark1: requestBody.Mark01
          mark5: requestBody.Mark05
      - text: Upsert the appraisal for {employee} on {date} at {timestamp}, scoring {mark1} through {mark5}.
        slots:
          employee: requestBody.Employee
          date: requestBody.Date
          timestamp: requestBody.DayTimestamp
          mark1: requestBody.Mark01
          mark5: requestBody.Mark05
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an employee appraisal
      effect: write
      questions:
      - How do I record a new performance appraisal for an employee in Deputy?
      - Can I submit an employee's five review marks for a given day?
      instructions:
      - text: Record a new appraisal for {employee} on {date} with first mark {mark1} and last mark {mark5}.
        slots:
          employee: requestBody.Employee
          date: requestBody.Date
          mark1: requestBody.Mark01
          mark5: requestBody.Mark05
      - text: Submit a review for {employee} dated {date}, stamped {timestamp}, scoring {mark1} through {mark5}.
        slots:
          employee: requestBody.Employee
          date: requestBody.Date
          timestamp: requestBody.DayTimestamp
          mark1: requestBody.Mark01
          mark5: requestBody.Mark05
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create or update employee appraisals
      effect: write
      questions:
      - How do I create many employee appraisals in one request?
      - Can I update existing appraisals when bulk-creating them?
      instructions:
      - text: Bulk create or update these employee appraisals.
      - text: Process this array of employee appraisal records in one call.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get field metadata for employee appraisals
      effect: read
      questions:
      - Which fields and types does an employee appraisal record have?
      - What associations exist on the employee appraisal resource?
      instructions:
      - text: Show the field metadata for employee appraisals.
      - text: Describe the employee appraisal fields and their types.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Predict an existing employee appraisal
      effect: read
      questions:
      - Can I find the closest existing employee appraisal for a partial payload?
      - Which employee appraisal record matches this employee and date?
      instructions:
      - text: Predict the employee appraisal for {Employee} on {Date}.
        slots:
          Employee: requestBody.Employee
          Date: requestBody.Date
      - text: Find the existing employee appraisal matching {Employee} and {Date}.
        slots:
          Employee: requestBody.Employee
          Date: requestBody.Date
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee appraisals
      effect: read
      questions:
      - How do I search employee appraisals by employee?
      - Can I sort and page through employee appraisals?
      instructions:
      - text: Search employee appraisals matching {search}.
        slots:
          search: requestBody.search
      - text: Find employee appraisals sorted by {sort}, {max} at a time.
        slots:
          sort: requestBody.sort
          max: requestBody.max
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee appraisal
      effect: read
      questions:
      - How do I fetch one employee appraisal by its id?
      - What marks are on a specific employee appraisal?
      instructions:
      - text: Get employee appraisal {id}.
        slots:
          id: path.id
      - text: Show the marks on employee appraisal {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an employee appraisal
      effect: write
      questions:
      - How do I replace an appraisal that was already submitted for an employee?
      - Can I overwrite an existing employee appraisal by its id using PUT?
      instructions:
      - text: Replace employee appraisal {id} for {employee} on {date} with first mark {mark1} and last mark {mark5}.
        slots:
          id: path.id
          employee: requestBody.Employee
          date: requestBody.Date
          mark1: requestBody.Mark01
          mark5: requestBody.Mark05
      - text: Overwrite appraisal {id} for {employee} on {date} at {timestamp}, scoring {mark1} to {mark5}.
        slots:
          id: path.id
          employee: requestBody.Employee
          date: requestBody.Date
          timestamp: requestBody.DayTimestamp
          mark1: requestBody.Mark01
          mark5: requestBody.Mark05
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change marks on an existing employee appraisal
      effect: write
      questions:
      - How do I change the marks on an employee appraisal that already exists?
      - Can I edit an existing performance review by id using POST?
      instructions:
      - text: Update employee appraisal {id} for {employee} on {date} with first mark {mark1} and last mark {mark5}.
        slots:
          id: path.id
          employee: requestBody.Employee
          date: requestBody.Date
          mark1: requestBody.Mark01
          mark5: requestBody.Mark05
      - text: Adjust appraisal {id} for {employee} dated {date}, stamped {timestamp}, to scores {mark1} through {mark5}.
        slots:
          id: path.id
          employee: requestBody.Employee
          date: requestBody.Date
          timestamp: requestBody.DayTimestamp
          mark1: requestBody.Mark01
          mark5: requestBody.Mark05
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an employee appraisal
      effect: destructive
      questions:
      - How do I delete an employee appraisal?
      - Can I remove an appraisal record by id?
      instructions:
      - text: Delete employee appraisal {id}.
        slots:
          id: path.id
      - text: Remove appraisal record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on an employee appraisal
      effect: read
      questions:
      - How do I see the comments on an employee appraisal?
      - Who left comments on a specific appraisal?
      instructions:
      - text: List comments on employee appraisal {id}.
        slots:
          id: path.id
      - text: Show the comment history of appraisal {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to an employee appraisal
      effect: write
      questions:
      - How do I add a comment to an employee appraisal?
      - Can I leave a note on an appraisal record?
      instructions:
      - text: Add comment {Comment} to employee appraisal {id}.
        slots:
          Comment: requestBody.Comment
          id: path.id
      - text: Comment {Comment} on appraisal {id}.
        slots:
          Comment: requestBody.Comment
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on an employee appraisal
      effect: destructive
      questions:
      - How do I delete a comment from an employee appraisal?
      - Can I remove a single comment on an appraisal?
      instructions:
      - text: Delete comment {commentId} from employee appraisal {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove comment {commentId} on appraisal {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of an employee appraisal
      effect: read
      questions:
      - How do I see the change history of an employee appraisal?
      - Who changed an appraisal and when?
      instructions:
      - text: Show the change history of employee appraisal {id}.
        slots:
          id: path.id
      - text: List every edit made to appraisal {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmployeeAppraisal/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee appraisal as it was at a past time
      effect: read
      questions:
      - How do I see an employee appraisal as it existed at a past time?
      - Can I travel back to an appraisal before a change?
      instructions:
      - text: Show employee appraisal {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to appraisal {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-employeeappraisal-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.