Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Employment Contract API

17 actions 17 updates phrasing extends openapi/deputy-employmentcontract-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/EmploymentContract'].get
$.paths['/resource/EmploymentContract'].put
$.paths['/resource/EmploymentContract'].post
$.paths['/resource/EmploymentContract/BULK'].post
$.paths['/resource/EmploymentContract/INFO'].get
$.paths['/resource/EmploymentContract/PREDICT'].post
$.paths['/resource/EmploymentContract/QUERY'].post
$.paths['/resource/EmploymentContract/{id}'].get
$.paths['/resource/EmploymentContract/{id}'].put
$.paths['/resource/EmploymentContract/{id}'].post
$.paths['/resource/EmploymentContract/{id}'].delete
$.paths['/resource/EmploymentContract/{id}/COMMENTS'].get
$.paths['/resource/EmploymentContract/{id}/COMMENTS'].post
$.paths['/resource/EmploymentContract/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmploymentContract/{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 Employment Contract API
  version: 1.0.0
extends: openapi/deputy-employmentcontract-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/EmploymentContract'].get
  update:
    x-apievangelist-phrasing:
      intent: List employment contracts
      effect: read
      questions:
      - Which employment contracts do I have access to?
      - Can I page through employment contracts with a large table?
      instructions:
      - text: List all employment contracts.
      - text: Show every employment contract record I can see.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an employment contract (PUT)
      effect: write
      questions:
      - How do I create an employment contract with a PUT request?
      - Can I replace an existing employment contract record in one call?
      instructions:
      - text: Create employment contract {name} with basis {basis}, category {category}, status {status}, pay rule {pay_rule}, period type {period_type}, modified {modified}.
        slots:
          name: requestBody.Name
          basis: requestBody.EmploymentBasis
          category: requestBody.EmploymentCategory
          status: requestBody.EmploymentStatus
          pay_rule: requestBody.BasePayRule
          period_type: requestBody.PeriodType
          modified: requestBody.Modified
      - text: PUT a new employment contract {name} for {basis} {category} {status} on {period_type}, modified {modified}.
        slots:
          name: requestBody.Name
          basis: requestBody.EmploymentBasis
          category: requestBody.EmploymentCategory
          status: requestBody.EmploymentStatus
          period_type: requestBody.PeriodType
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an employment contract (POST)
      effect: write
      questions:
      - Can I POST a new employment contract record?
      - What does a POST create call for an employment contract need?
      instructions:
      - text: POST a new employment contract {name} with basis {basis}, category {category}, status {status}, pay rule {pay_rule}, period type {period_type}, modified {modified}.
        slots:
          name: requestBody.Name
          basis: requestBody.EmploymentBasis
          category: requestBody.EmploymentCategory
          status: requestBody.EmploymentStatus
          pay_rule: requestBody.BasePayRule
          period_type: requestBody.PeriodType
          modified: requestBody.Modified
      - text: Create an employment contract {name} for {basis} {category} {status} on {period_type}, modified {modified}.
        slots:
          name: requestBody.Name
          basis: requestBody.EmploymentBasis
          category: requestBody.EmploymentCategory
          status: requestBody.EmploymentStatus
          period_type: requestBody.PeriodType
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create or update employment contracts
      effect: write
      questions:
      - How do I create many employment contracts in one request?
      - Can I update existing employment contracts in bulk?
      instructions:
      - text: Bulk create or update these employment contracts.
      - text: Process this array of employment contract records in one call.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employment contract field metadata
      effect: read
      questions:
      - Which fields and types exist on an employment contract?
      - Can I see the associations of the employment contract resource?
      instructions:
      - text: Get the field metadata for employment contracts.
      - text: Show which employment contract fields are queryable.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Predict an existing employment contract
      effect: read
      questions:
      - Can I find an existing employment contract before creating one?
      - How do I upsert an employment contract by matching its fields?
      instructions:
      - text: Predict the existing employment contract for {name} with basis {basis}, category {category}, status {status}, pay rule {pay_rule}, period type {period_type}, modified {modified}.
        slots:
          name: requestBody.Name
          basis: requestBody.EmploymentBasis
          category: requestBody.EmploymentCategory
          status: requestBody.EmploymentStatus
          pay_rule: requestBody.BasePayRule
          period_type: requestBody.PeriodType
          modified: requestBody.Modified
      - text: Find the closest existing employment contract for {name} on {period_type}, modified {modified}.
        slots:
          name: requestBody.Name
          period_type: requestBody.PeriodType
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employment contracts
      effect: read
      questions:
      - How do I find employment contracts matching a search?
      - Can I sort and page employment contract search results?
      instructions:
      - text: Search employment contracts matching {search}.
        slots:
          search: requestBody.search
      - text: Find employment contracts where {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employment contract
      effect: read
      questions:
      - What are the details of one employment contract?
      - Can I fetch an employment contract by its id?
      instructions:
      - text: Get employment contract {id}.
        slots:
          id: path.id
      - text: Show the details of employment contract {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an employment contract (PUT)
      effect: write
      questions:
      - How do I fully replace an employment contract record?
      - Can I PUT an entire employment contract with its fields?
      instructions:
      - text: Replace employment contract {id} with name {name}, basis {basis}, category {category}, status {status}, pay rule {pay_rule}, period type {period_type}, modified {modified}.
        slots:
          id: path.id
          name: requestBody.Name
          basis: requestBody.EmploymentBasis
          category: requestBody.EmploymentCategory
          status: requestBody.EmploymentStatus
          pay_rule: requestBody.BasePayRule
          period_type: requestBody.PeriodType
          modified: requestBody.Modified
      - text: PUT the full employment contract {id} with {name} on {period_type}, modified {modified}.
        slots:
          id: path.id
          name: requestBody.Name
          period_type: requestBody.PeriodType
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an employment contract (POST)
      effect: write
      questions:
      - Can I POST partial changes to an employment contract?
      - What does a POST update call for an employment contract need?
      instructions:
      - text: 'POST partial changes to employment contract {id}: name {name}, basis {basis}, category {category}, status {status}, pay rule {pay_rule}, period type {period_type}, modified {modified}.'
        slots:
          id: path.id
          name: requestBody.Name
          basis: requestBody.EmploymentBasis
          category: requestBody.EmploymentCategory
          status: requestBody.EmploymentStatus
          pay_rule: requestBody.BasePayRule
          period_type: requestBody.PeriodType
          modified: requestBody.Modified
      - text: Update employment contract {id} with {name} on {period_type}, modified {modified}.
        slots:
          id: path.id
          name: requestBody.Name
          period_type: requestBody.PeriodType
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an employment contract
      effect: destructive
      questions:
      - How do I delete an employment contract?
      - Can I remove an employment contract record?
      instructions:
      - text: Delete employment contract {id}.
        slots:
          id: path.id
      - text: Remove the employment contract with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on an employment contract
      effect: read
      questions:
      - What comments have been left on an employment contract?
      - Can I see the comment history for an employment contract?
      instructions:
      - text: List comments on employment contract {id}.
        slots:
          id: path.id
      - text: Show the comment history for employment contract {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to an employment contract
      effect: write
      questions:
      - How do I add a comment to an employment contract?
      - Can I leave a comment on an employment contract?
      instructions:
      - text: Add comment {comment} to employment contract {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment {comment} on employment contract {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on an employment contract
      effect: destructive
      questions:
      - How do I delete a comment from an employment contract?
      - Can I remove one comment on an employment contract?
      instructions:
      - text: Delete comment {comment_id} from employment contract {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      - text: Remove comment {comment_id} on employment contract {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history for an employment contract
      effect: read
      questions:
      - What changes have been made to an employment contract?
      - Can I see the change history of an employment contract?
      instructions:
      - text: Get the change history of employment contract {id}.
        slots:
          id: path.id
      - text: Show every change made to employment contract {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContract/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employment contract as it was at a past time
      effect: read
      questions:
      - How do I see an employment contract as it was at a prior time?
      - Can I travel back to an employment contract's state at a timestamp?
      instructions:
      - text: Get employment contract {id} as it existed at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Show employment contract {id} as of {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-employmentcontract-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.