Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Employment Condition API

11 actions 11 updates phrasing extends openapi/deputy-employmentcondition-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/EmploymentCondition'].get
$.paths['/resource/EmploymentCondition/INFO'].get
$.paths['/resource/EmploymentCondition/PREDICT'].post
$.paths['/resource/EmploymentCondition/QUERY'].post
$.paths['/resource/EmploymentCondition/{id}'].get
$.paths['/resource/EmploymentCondition/{id}/COMMENTS'].get
$.paths['/resource/EmploymentCondition/{id}/COMMENTS'].post
$.paths['/resource/EmploymentCondition/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmploymentCondition/{id}/HISTORY'].get
$.paths['/resource/EmploymentCondition/{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 Employment Condition API
  version: 1.0.0
extends: openapi/deputy-employmentcondition-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/EmploymentCondition'].get
  update:
    x-apievangelist-phrasing:
      intent: List employment conditions
      effect: read
      questions:
      - What employment conditions are set up for staff?
      - Can I list all employment conditions in a large table?
      instructions:
      - text: List all employment conditions.
      - text: Show every employment condition record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentCondition/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employment condition field metadata
      effect: read
      questions:
      - Which fields can I search on when looking up an employment condition?
      - What types and associations does the employment condition resource have?
      instructions:
      - text: Show the field metadata for employment conditions.
      - text: List the queryable fields and associations of employment condition.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentCondition/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing employment condition
      effect: read
      questions:
      - Can I find an existing employment condition by name and usual hours before creating one?
      - Which fields does the employment condition prediction need?
      instructions:
      - text: Find the employment condition matching name {name} with {working_days_per_period} working days per period.
        slots:
          name: requestBody.Name
          working_days_per_period: requestBody.WorkingDaysPerPeriod
      - text: Predict an existing employment condition for {name} on {employment_basis} with {working_days_per_period} days per period.
        slots:
          name: requestBody.Name
          employment_basis: requestBody.EmploymentBasis
          working_days_per_period: requestBody.WorkingDaysPerPeriod
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentCondition/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employment conditions
      effect: read
      questions:
      - Can I search employment conditions by name or award level?
      - How do I sort employment conditions by a field?
      instructions:
      - text: Search employment conditions where {search}.
        slots:
          search: requestBody.search
      - text: Find employment conditions matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentCondition/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employment condition
      effect: read
      questions:
      - What are the details of one employment condition?
      - Can I fetch an employment condition by its id?
      instructions:
      - text: Get employment condition {id}.
        slots:
          id: path.id
      - text: Show the employment condition record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentCondition/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on an employment condition
      effect: read
      questions:
      - What comments have been left on an employment condition?
      - Can I see the comment history for an employment condition?
      instructions:
      - text: List comments on employment condition {id}.
        slots:
          id: path.id
      - text: Show the comment history for employment condition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentCondition/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on an employment condition
      effect: write
      questions:
      - Can I add a comment to an employment condition?
      - How do I annotate an employment condition with a note?
      instructions:
      - text: Add comment {comment} to employment condition {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment {comment} on employment condition {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentCondition/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on an employment condition
      effect: destructive
      questions:
      - Can I remove a comment from an employment condition?
      - How do I delete a comment on an employment condition?
      instructions:
      - text: Delete comment {comment_id} from employment condition {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      - text: Remove comment {comment_id} on employment condition {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentCondition/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of an employment condition
      effect: read
      questions:
      - What changes have been made to an employment condition over time?
      - Can I see the full change history of an employment condition?
      instructions:
      - text: Show the change history of employment condition {id}.
        slots:
          id: path.id
      - text: List every change made to employment condition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/EmploymentCondition/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employment condition as it was at a past time
      effect: read
      questions:
      - Can I see an employment condition as it existed at a specific past time?
      - What did an employment condition look like at a given timestamp?
      instructions:
      - text: Show employment condition {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Get the employment condition {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-employmentcondition-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.