Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata Custom Field Definitions API

3 actions 3 updates phrasing extends openapi/drata-custom-field-definitions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Drata's API. It is a proposal applied on top of the contract, not a document Drata publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/custom-field-definitions'].get
$.paths['/custom-field-definitions/{customFieldId}'].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 Drata Custom Field Definitions API
  version: 1.0.0
extends: openapi/drata-custom-field-definitions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/custom-field-definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions
      effect: read
      questions:
      - What custom fields have we defined in Drata?
      - Can I list custom fields for one entity type, like risks?
      instructions:
      - text: List all custom field definitions.
      - text: Show custom fields defined for entity type {entity_type}.
        slots:
          entity_type: query.entityType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-field-definitions/{customFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom field definition
      effect: read
      questions:
      - Can I look up a custom field by its name instead of its ID?
      - What type and options does a particular custom field have?
      instructions:
      - text: Get custom field definition {field}.
        slots:
          field: path.customFieldId
      - text: Show the definition of custom field {field}.
        slots:
          field: path.customFieldId
      method: generated
      generated: '2026-09-26'