Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Custom Field API

17 actions 17 updates phrasing extends openapi/deputy-custom-field-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/CustomField'].get
$.paths['/resource/CustomField'].put
$.paths['/resource/CustomField'].post
$.paths['/resource/CustomField/BULK'].post
$.paths['/resource/CustomField/INFO'].get
$.paths['/resource/CustomField/PREDICT'].post
$.paths['/resource/CustomField/QUERY'].post
$.paths['/resource/CustomField/{id}'].get
$.paths['/resource/CustomField/{id}'].put
$.paths['/resource/CustomField/{id}'].post
$.paths['/resource/CustomField/{id}'].delete
$.paths['/resource/CustomField/{id}/COMMENTS'].get
$.paths['/resource/CustomField/{id}/COMMENTS'].post
$.paths['/resource/CustomField/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/CustomField/{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 Custom Field API
  version: 1.0.0
extends: openapi/deputy-custom-field-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/CustomField'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom fields
      effect: read
      questions:
      - Which custom fields are defined on a resource?
      - Can I see all custom field definitions at once?
      instructions:
      - text: List all custom fields.
      - text: Show every custom field on this resource.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a custom field
      effect: write
      questions:
      - How do I create a custom field on a resource?
      - Can I replace an existing custom field by its ID?
      instructions:
      - text: Create custom field {name} of type {type} with API name {api_name}.
        slots:
          name: requestBody.Name
          type: requestBody.Type
          api_name: requestBody.ApiName
      - text: Replace custom field {id} with name {name}, type {type}, API name {api_name}.
        slots:
          id: requestBody.Id
          name: requestBody.Name
          type: requestBody.Type
          api_name: requestBody.ApiName
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom field
      effect: write
      questions:
      - How do I add a new custom field to a resource?
      - What's needed to define a custom field, like its API name and type?
      instructions:
      - text: Create a new custom field {name} of type {type} with API name {api_name}.
        slots:
          name: requestBody.Name
          type: requestBody.Type
          api_name: requestBody.ApiName
      - text: Add a custom field {name} on {field} with type {type} and API name {api_name}.
        slots:
          name: requestBody.Name
          field: requestBody.DeputyField
          type: requestBody.Type
          api_name: requestBody.ApiName
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many custom fields at once
      effect: write
      questions:
      - Can I create or update several custom fields in one request?
      - How do I bulk-load custom field definitions?
      instructions:
      - text: Bulk create or update these custom fields.
      - text: Apply this batch of custom field changes.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom field metadata
      effect: read
      questions:
      - What field types and associations exist for a resource's custom fields?
      - Which fields on a resource can I query?
      instructions:
      - text: Get the field metadata for custom fields.
      - text: Show the field list and types for resource custom fields.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing custom field by partial details
      effect: read
      questions:
      - Can I find an existing custom field before creating a duplicate?
      - Which custom field matches a partial payload of name and type?
      instructions:
      - text: Predict-match a custom field named {name} of type {type}.
        slots:
          name: requestBody.Name
          type: requestBody.Type
      - text: Find the existing custom field with API name {api_name} and name {name}.
        slots:
          api_name: requestBody.ApiName
          name: requestBody.Name
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search custom fields
      effect: read
      questions:
      - How do I find custom fields whose name contains a word?
      - Can I sort custom fields by a field?
      instructions:
      - text: Search custom fields where {search}.
        slots:
          search: requestBody.search
      - text: Find custom fields matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom field
      effect: read
      questions:
      - What type and API name does a custom field have?
      - Can I look up one custom field by its ID?
      instructions:
      - text: Get custom field {id}.
        slots:
          id: path.id
      - text: Show the details of custom field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom field
      effect: write
      questions:
      - How do I change the options or validation on a custom field?
      - Can I make an existing custom field visible to employees?
      instructions:
      - text: Update custom field {id} named {name}.
        slots:
          id: path.id
          name: requestBody.Name
      - text: Set the value list of custom field {id} to {value_list}.
        slots:
          id: path.id
          value_list: requestBody.Valuelist
      - text: Update custom field {id} to validate {validation}.
        slots:
          id: path.id
          validation: requestBody.Validation
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a custom field (POST)
      effect: write
      questions:
      - Can I partially update a custom field with a POST?
      - What does a POST update to a custom field change?
      instructions:
      - text: POST-update custom field {id} with name {name}, type {type}, API name {api_name}.
        slots:
          id: path.id
          name: requestBody.Name
          type: requestBody.Type
          api_name: requestBody.ApiName
      - text: Send a partial custom field update to {id} changing its type to {type}.
        slots:
          id: path.id
          type: requestBody.Type
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field
      effect: destructive
      questions:
      - How do I delete a custom field?
      - Can I remove a custom field by its ID?
      instructions:
      - text: Delete custom field {id}.
        slots:
          id: path.id
      - text: Remove the custom field with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a custom field
      effect: read
      questions:
      - What comments have been left on a custom field?
      - Can I read the comment history of a custom field?
      instructions:
      - text: List comments on custom field {id}.
        slots:
          id: path.id
      - text: Show the comment history of custom field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a custom field
      effect: write
      questions:
      - How do I annotate a custom field with a comment?
      - Can I add a note to a custom field?
      instructions:
      - text: Add comment {comment} to custom field {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment {comment} on custom field {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a custom field
      effect: destructive
      questions:
      - How do I remove a comment from a custom field?
      - Can I delete a single comment on a custom field?
      instructions:
      - text: Delete comment {comment_id} from custom field {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      - text: Remove comment {comment_id} on custom field {id}.
        slots:
          comment_id: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history for a custom field
      effect: read
      questions:
      - What changes have been made to a custom field over time?
      - Can I see the edit history of a custom field?
      instructions:
      - text: Show the change history of custom field {id}.
        slots:
          id: path.id
      - text: List every edit made to custom field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/CustomField/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom field as it was at a past time
      effect: read
      questions:
      - How do I see what a custom field looked like at a past moment?
      - Can I travel back to a custom field's state before a change?
      instructions:
      - text: Get custom field {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Show custom field {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-custom-field-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.