Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy Journal API

19 actions 19 updates phrasing extends openapi/deputy-journal-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 19 · first 16 shown; the file carries all of them

$.info
$.paths['/resource/Journal'].get
$.paths['/resource/Journal'].put
$.paths['/resource/Journal'].post
$.paths['/resource/Journal/BULK'].post
$.paths['/resource/Journal/INFO'].get
$.paths['/resource/Journal/PREDICT'].post
$.paths['/resource/Journal/QUERY'].post
$.paths['/resource/Journal/{id}'].get
$.paths['/resource/Journal/{id}'].put
$.paths['/resource/Journal/{id}'].post
$.paths['/resource/Journal/{id}'].delete
$.paths['/resource/Journal/{id}/COMMENTS'].get
$.paths['/resource/Journal/{id}/COMMENTS'].post
$.paths['/resource/Journal/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Journal/{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 Journal API
  version: 1.0.0
extends: openapi/deputy-journal-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: 18
- target: $.paths['/resource/Journal'].get
  update:
    x-apievangelist-phrasing:
      intent: List journal entries
      effect: read
      questions:
      - What journal entries have been logged in Deputy?
      - Can I page through journal records for a large table?
      instructions:
      - text: List all journal entries.
      - text: Show every journal record the caller is permitted to see.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a journal entry (PUT)
      effect: write
      questions:
      - How do I create a journal entry with a PUT request?
      - Can I replace a journal entry by its id?
      instructions:
      - text: Create a journal entry with id {id} dated {date} saying {comment}.
        slots:
          id: requestBody.Id
          date: requestBody.Date
          comment: requestBody.Comment
      - text: PUT a journal record {id} for {date} with comment {comment}.
        slots:
          id: requestBody.Id
          date: requestBody.Date
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a journal entry (POST)
      effect: write
      questions:
      - Can I post a new journal entry for an employee?
      - What fields are required to create a journal record?
      instructions:
      - text: Create a journal entry for employee {employee} on {date} saying {comment}.
        slots:
          employee: requestBody.EmployeeId
          date: requestBody.Date
          comment: requestBody.Comment
      - text: POST a new journal record with id {id}, date {date}, comment {comment}.
        slots:
          id: requestBody.Id
          date: requestBody.Date
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create or update journal entries
      effect: write
      questions:
      - Can I create many journal entries in one request?
      - How do I upsert a batch of journal records?
      instructions:
      - text: Bulk create or update these journal entries.
      - text: Upsert an array of journal records in one call.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get journal field metadata
      effect: read
      questions:
      - Which fields can I query on journal entries?
      - What field types and associations does the journal resource have?
      instructions:
      - text: Get the field metadata for the journal resource.
      - text: Show which journal fields are queryable.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Predict-match a journal entry
      effect: read
      questions:
      - Can I find an existing journal entry before creating one?
      - What is the closest match for a journal comment on a date?
      instructions:
      - text: Predict-match a journal entry for {date} with comment {comment}.
        slots:
          date: requestBody.Date
          comment: requestBody.Comment
      - text: Find the existing journal record matching {date} and {comment}.
        slots:
          date: requestBody.Date
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search journal entries
      effect: read
      questions:
      - Can I search journal entries by comment?
      - How do I sort journal records and page through them?
      instructions:
      - text: Search journals for comment {comment}.
        slots:
          comment: requestBody.search
      - text: Find journal entries matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journal entry
      effect: read
      questions:
      - How do I read one journal entry by id?
      - What comment is stored on a specific journal record?
      instructions:
      - text: Get journal entry {id}.
        slots:
          id: path.id
      - text: Show the comment on journal record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a journal entry (PUT)
      effect: write
      questions:
      - Can I overwrite a journal entry with a PUT request?
      - What does a full journal update require?
      instructions:
      - text: Replace journal entry {id} with id {id}, date {date}, comment {comment}.
        slots:
          id: path.id
          date: requestBody.Date
          comment: requestBody.Comment
      - text: PUT a complete journal record {id} dated {date} saying {comment}.
        slots:
          id: path.id
          date: requestBody.Date
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a journal entry (POST)
      effect: write
      questions:
      - Can I partially update a journal entry with a POST request?
      - Which fields can I change on an existing journal record?
      instructions:
      - text: Update journal entry {id} with comment {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      - text: POST a partial change to journal record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a journal entry
      effect: destructive
      questions:
      - How do I delete a journal entry?
      - Can I remove a journal record by id?
      instructions:
      - text: Delete journal entry {id}.
        slots:
          id: path.id
      - text: Remove the journal record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a journal entry
      effect: read
      questions:
      - What comments have been left on a journal entry?
      - Can I read the comment history of a journal record?
      instructions:
      - text: List comments on journal entry {id}.
        slots:
          id: path.id
      - text: Show the comment history for journal record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a journal entry
      effect: write
      questions:
      - How do I add a comment to a journal entry?
      - Can I annotate a journal record with a comment?
      instructions:
      - text: Add comment {comment} to journal entry {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment journal record {id} with {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a journal entry
      effect: destructive
      questions:
      - How do I remove a comment from a journal entry?
      - Can I delete a single comment on a journal record?
      instructions:
      - text: Delete comment {commentId} from journal entry {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove comment {commentId} on journal record {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of a journal entry
      effect: read
      questions:
      - What changes have been made to a journal entry?
      - Can I see the edit history of a journal record?
      instructions:
      - text: Show the change history of journal entry {id}.
        slots:
          id: path.id
      - text: List every edit made to journal record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Journal/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a journal entry as it existed at a past time
      effect: read
      questions:
      - Can I see a journal entry as it looked at a past moment?
      - What did a journal record contain at a specific timestamp?
      instructions:
      - text: Show journal entry {id} as it existed at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to journal record {id} at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/journal'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a journal entry (supervise)
      effect: write
      questions:
      - How do I create or update a journal entry through the supervise endpoint?
      - Can the supervise journal endpoint upsert a record?
      instructions:
      - text: Create or update a journal entry through the supervise endpoint.
      - text: Upsert a journal record using supervise/journal.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/journal/{date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the journal for a date
      effect: read
      questions:
      - What journal entries were logged on a given date?
      - Can I fetch the journal for a specific day?
      instructions:
      - text: Get the journal for {date}.
        slots:
          date: path.date
      - text: Show all journal entries logged on {date}.
        slots:
          date: path.date
      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-journal-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.