Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy Getrecommendation API

8 actions 8 updates phrasing extends openapi/deputy-getrecommendation-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 8

$.info
$.paths['/my/getrecommendation/{intRosterId}'].get
$.paths['/supervise/getrecommendation/{intRosterId}'].get
$.paths['/supervise/getrecommendation/{intRosterId}'].post
$.paths['/supervise/getrecommendation/{intRosterId}/notify'].post
$.paths['/supervise/getrecommendation/{intRosterId}/notifyallrecommended'].post
$.paths['/supervise/getrecommendation/{intRosterId}/reset'].post
$.paths['/supervise/getrecommendation/{intRosterId}/status'].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 Getrecommendation API
  version: 1.0.0
extends: openapi/deputy-getrecommendation-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: 7
- target: $.paths['/my/getrecommendation/{intRosterId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get skill recommendations by roster
      effect: read
      questions:
      - Can I get skill recommendations for one roster?
      - What does a roster's skill recommendation look like?
      instructions:
      - text: Get skill recommendations for roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      - text: Show the skills recommended for roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/getrecommendation/{intRosterId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a roster recommendation for a roster
      effect: read
      questions:
      - What does the roster recommendation look like for a roster I supervise?
      - Can I see the recommendation for a roster I'm overseeing?
      instructions:
      - text: Get the roster recommendation for roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      - text: Show the recommendation for roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/getrecommendation/{intRosterId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a roster recommendation for a roster
      effect: write
      questions:
      - How do I send a roster recommendation for a roster I supervise?
      - Can I post a recommendation for a roster?
      instructions:
      - text: Send a roster recommendation for roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      - text: Post a recommendation for roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/getrecommendation/{intRosterId}/notify'].post
  update:
    x-apievangelist-phrasing:
      intent: Notify a roster of its recommendation
      effect: write
      questions:
      - How do I notify a roster that its recommendation is ready?
      - Can I send a notification about a roster's recommendation?
      instructions:
      - text: Notify roster {intRosterId} that its recommendation is ready.
        slots:
          intRosterId: path.intRosterId
      - text: Send a recommendation notification for roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/getrecommendation/{intRosterId}/notifyallrecommended'].post
  update:
    x-apievangelist-phrasing:
      intent: Notify all rostered staff of their recommendation
      effect: write
      questions:
      - How do I notify every rostered staff member of their recommendation?
      - Can I broadcast a recommendation notification to all rostered staff?
      instructions:
      - text: Notify all rostered staff of their recommendation for roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      - text: Broadcast a recommendation notification to every rostered staff member on roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/getrecommendation/{intRosterId}/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a roster recommendation
      effect: destructive
      questions:
      - How do I reset a roster recommendation so it can be recomputed?
      - Can I clear a roster's recommendation?
      instructions:
      - text: Reset the roster recommendation for roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      - text: Clear the recommendation on roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/getrecommendation/{intRosterId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a roster recommendation status
      effect: read
      questions:
      - Is the recommendation for a roster still pending or has it been sent?
      - What is the status of a roster's recommendation?
      instructions:
      - text: Get the recommendation status for roster {intRosterId}.
        slots:
          intRosterId: path.intRosterId
      - text: Check whether roster {intRosterId}'s recommendation has been sent.
        slots:
          intRosterId: path.intRosterId
      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-getrecommendation-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.