Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Training Record API

17 actions 17 updates phrasing extends openapi/deputy-trainingrecord-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/TrainingRecord'].get
$.paths['/resource/TrainingRecord'].put
$.paths['/resource/TrainingRecord'].post
$.paths['/resource/TrainingRecord/BULK'].post
$.paths['/resource/TrainingRecord/INFO'].get
$.paths['/resource/TrainingRecord/PREDICT'].post
$.paths['/resource/TrainingRecord/QUERY'].post
$.paths['/resource/TrainingRecord/{id}'].get
$.paths['/resource/TrainingRecord/{id}'].put
$.paths['/resource/TrainingRecord/{id}'].post
$.paths['/resource/TrainingRecord/{id}'].delete
$.paths['/resource/TrainingRecord/{id}/COMMENTS'].get
$.paths['/resource/TrainingRecord/{id}/COMMENTS'].post
$.paths['/resource/TrainingRecord/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/TrainingRecord/{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 Training Record API
  version: 1.0.0
extends: openapi/deputy-trainingrecord-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/TrainingRecord'].get
  update:
    x-apievangelist-phrasing:
      intent: List training records
      effect: read
      questions:
      - Which training records have employees completed?
      - Can I list training records for one employee?
      instructions:
      - text: List all training records.
      - text: Show every training record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a training record
      effect: write
      questions:
      - How do I add a training record for an employee?
      - Can I replace an existing training record by its ID?
      instructions:
      - text: Create training record {id} for employee {employee} on module {module} dated {training_date}, active {active}.
        slots:
          id: requestBody.Id
          employee: requestBody.Employee
          module: requestBody.Module
          training_date: requestBody.TrainingDate
          active: requestBody.Active
      - text: Replace training record {id} with {employee}, {module}, {training_date}, active {active}.
        slots:
          id: requestBody.Id
          employee: requestBody.Employee
          module: requestBody.Module
          training_date: requestBody.TrainingDate
          active: requestBody.Active
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an employee's training
      effect: write
      questions:
      - How do I record that an employee completed a training module?
      - Can a training record have an expiry date or be kept active?
      - Can I attach a training certificate file to a record?
      instructions:
      - text: Create a training record for {employee} on {module} with date {date}.
        slots:
          employee: requestBody.Employee
          module: requestBody.Module
          date: requestBody.TrainingDate
      - text: Record training for {employee} on {module} until {expiry}.
        slots:
          employee: requestBody.Employee
          module: requestBody.Module
          expiry: requestBody.ExpiryDate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create or update training records
      effect: write
      questions:
      - Can I import many training records at once?
      - How do I upsert a batch of training records?
      instructions:
      - text: Bulk create or update these training records.
      - text: Upsert this batch of training records.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get training record field metadata
      effect: read
      questions:
      - Which fields can I search on for training records?
      - What types and associations does the training record resource have?
      instructions:
      - text: Show the field metadata for training records.
      - text: Describe the training record resource fields.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing training record
      effect: read
      questions:
      - Can I find the training record that matches an employee and module?
      - Which training record does a partial payload match?
      instructions:
      - text: Predict the training record for employee {employee} on module {module} on {training_date}, active {active}.
        slots:
          employee: requestBody.Employee
          module: requestBody.Module
          training_date: requestBody.TrainingDate
          active: requestBody.Active
      - text: Find the existing training record matching {employee}, {module}, {training_date}, active {active}.
        slots:
          employee: requestBody.Employee
          module: requestBody.Module
          training_date: requestBody.TrainingDate
          active: requestBody.Active
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search training records
      effect: read
      questions:
      - Which employees have completed a given training module?
      - Can I sort training records by date?
      instructions:
      - text: Search training records matching {search}.
        slots:
          search: requestBody.search
      - text: Find training records sorted by {sort}.
        slots:
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a training record
      effect: read
      questions:
      - What module and date are on a specific training record?
      - Can I fetch one training record by ID?
      instructions:
      - text: Get training record {id}.
        slots:
          id: path.id
      - text: Show the training record with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a training record
      effect: write
      questions:
      - How do I overwrite an existing training record?
      - Can I fully replace a training record by its ID?
      instructions:
      - text: Replace training record {id} with employee {employee}, module {module}, date {training_date}, active {active}.
        slots:
          id: path.id
          employee: requestBody.Employee
          module: requestBody.Module
          training_date: requestBody.TrainingDate
          active: requestBody.Active
      - text: Overwrite training record {id} with {employee}, {module}, {training_date}, active {active}.
        slots:
          id: path.id
          employee: requestBody.Employee
          module: requestBody.Module
          training_date: requestBody.TrainingDate
          active: requestBody.Active
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a training record
      effect: write
      questions:
      - Can I change the expiry date on an existing training record?
      - How do I edit a training record's comment?
      instructions:
      - text: Update training record {id} to expire on {expiry_date}.
        slots:
          id: path.id
          expiry_date: requestBody.ExpiryDate
      - text: Edit training record {id} with comment {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a training record
      effect: destructive
      questions:
      - How do I remove a training record?
      - Can I delete a completed training record?
      instructions:
      - text: Delete training record {id}.
        slots:
          id: path.id
      - text: Remove training record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a training record
      effect: read
      questions:
      - What comments have been left on a training record?
      - Can I see the notes on a training record?
      instructions:
      - text: List comments on training record {id}.
        slots:
          id: path.id
      - text: Show the notes on training record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a training record
      effect: write
      questions:
      - How do I add a note to a training record?
      - Can I comment on a training record?
      instructions:
      - text: Add comment {comment} to training record {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment {comment} on training record {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a training record
      effect: destructive
      questions:
      - Can I delete a comment on an employee's training record?
      - What's the way to remove a training record comment?
      instructions:
      - text: Delete comment {comment} on training record {id}.
        slots:
          comment: path.commentId
          id: path.id
      - text: Remove comment {comment} from record {id}.
        slots:
          comment: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history for a training record
      effect: read
      questions:
      - Who changed a training record and when?
      - Can I see the edit history of a training record?
      instructions:
      - text: Show the change history of training record {id}.
        slots:
          id: path.id
      - text: List edits made to training record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TrainingRecord/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a training record at a past time
      effect: read
      questions:
      - What did a training record look like at a past date?
      - Can I travel back to an earlier version of a training record?
      instructions:
      - text: Show training record {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to training record {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-trainingrecord-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.