Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Comment API
11 actions
11 updates
phrasing
extends
openapi/deputy-comment-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/resource/Comment'].get
$.paths['/resource/Comment/INFO'].get
$.paths['/resource/Comment/PREDICT'].post
$.paths['/resource/Comment/QUERY'].post
$.paths['/resource/Comment/{id}'].get
$.paths['/resource/Comment/{id}/COMMENTS'].get
$.paths['/resource/Comment/{id}/COMMENTS'].post
$.paths['/resource/Comment/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Comment/{id}/HISTORY'].get
$.paths['/resource/Comment/{id}/HISTORY/travel/{timestamp}'].get
OpenAPI Overlay
# 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 Comment API
version: 1.0.0
extends: openapi/deputy-comment-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/Comment'].get
update:
x-apievangelist-phrasing:
intent: List comments on a resource
effect: read
questions:
- Which comments have been left on a resource record?
- Can I page through all comments on a resource?
instructions:
- text: List comments on this resource.
- text: Show every comment left on the resource record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Comment/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get comment field metadata
effect: read
questions:
- What fields and associations does the Comment resource have?
- Which Comment fields can I query?
instructions:
- text: Get the field metadata for the Comment resource.
- text: Show which Comment fields are queryable.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Comment/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing comment by partial data
effect: read
questions:
- Can I find an existing comment before creating a duplicate?
- What fields does the comment-predict match use?
instructions:
- text: Predict the existing comment for {Comment}.
slots:
Comment: requestBody.Comment
- text: Find the matching comment using {Comment} and modified {Modified}.
slots:
Comment: requestBody.Comment
Modified: requestBody.Modified
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Comment/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search comments
effect: read
questions:
- How do I search comments on a resource?
- Can I sort and join comments with related records?
instructions:
- text: Search comments matching {search}.
slots:
search: requestBody.search
- text: Find comments matching {search} sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Comment/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a comment by id
effect: read
questions:
- What does a single comment record contain?
- Can I fetch one comment by its id?
instructions:
- text: Get comment {id}.
slots:
id: path.id
- text: Show the details of comment {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Comment/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a comment
effect: read
questions:
- Which comments are on a given comment?
- Can I see the replies to a comment?
instructions:
- text: List comments on comment {id}.
slots:
id: path.id
- text: Show the replies to comment {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Comment/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Reply to a comment
effect: write
questions:
- How do I reply to a comment?
- Can I add a comment as a reply to another comment?
instructions:
- text: Reply to comment {id} with {Comment}.
slots:
id: path.id
Comment: requestBody.Comment
- text: Add a comment {Comment} as a reply on comment {id}.
slots:
Comment: requestBody.Comment
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Comment/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a comment
effect: destructive
questions:
- How do I remove a reply to a comment on a resource?
- Can I delete a child comment that another user posted?
instructions:
- text: Delete comment {commentId} on the comment of resource {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove reply {commentId} to the resource {id} comment.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Comment/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get a comment's change history
effect: read
questions:
- What changes have been made to a comment?
- Can I see the edit history of a comment?
instructions:
- text: Show the change history of comment {id}.
slots:
id: path.id
- text: List edits made to comment {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Comment/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: View a comment as it was at a past time
effect: read
questions:
- Can I see what a comment looked like at a past moment?
- How do I travel back to a comment's state at a timestamp?
instructions:
- text: Show comment {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to comment {id} at {timestamp} and show it.
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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-comment-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.