# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Workfront Planning API Version 2 Fields API
  version: 1.0.0
extends: openapi/workfront-fields-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v2/fields/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field by ID
      effect: read
      questions:
      - How do I see a field's type and options, like the choices on a single-select?
      - What configuration comes back when I look up one field?
      instructions:
      - text: Get field {id}.
        slots:
          id: path.id
      - text: Show me the type and select options configured on field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/fields/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a field's definition in full
      effect: write
      questions:
      - What happens to field settings I omit when I fully replace a field?
      - Can I overwrite a field's whole configuration, including its type, in one call?
      instructions:
      - text: Fully replace field {id} as {displayName} of type {type}, clearing anything not sent.
        slots:
          id: path.id
          displayName: requestBody.displayName
          type: requestBody.type
      - text: Overwrite field {id} with the select options {options}.
        slots:
          id: path.id
          options: requestBody.options
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/fields/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field
      effect: destructive
      questions:
      - How do I remove a field from a record type?
      - Can I delete a column I no longer need by its field ID?
      instructions:
      - text: Delete field {id}.
        slots:
          id: path.id
      - text: Remove the field with ID {id} from its record type.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/fields/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change some settings on a field
      effect: write
      questions:
      - Can I rename a field without resending its options?
      - Is it possible to update only a field's description?
      instructions:
      - text: Rename field {id} to {displayName}, leaving the rest unchanged.
        slots:
          id: path.id
          displayName: requestBody.displayName
      - text: Patch field {id} so its description reads {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/record-types/{recordTypeId}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List the fields on a record type
      effect: read
      questions:
      - What fields does a record type have?
      - Can I page through a record type's fields 100 at a time?
      instructions:
      - text: List the fields on record type {recordTypeId}.
        slots:
          recordTypeId: path.recordTypeId
      - text: Show the next {limit} fields of record type {recordTypeId} after cursor {cursor}.
        slots:
          limit: query.limit
          recordTypeId: path.recordTypeId
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/record-types/{recordTypeId}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field to a record type
      effect: write
      questions:
      - How do I add a new column, like a due date, to a record type?
      - What are the limits on formula, long-text and reference fields per record type?
      instructions:
      - text: Add a {type} field called {displayName} to record type {recordTypeId}.
        slots:
          type: requestBody.type
          displayName: requestBody.displayName
          recordTypeId: path.recordTypeId
      - text: Create a formula field {displayName} on record type {recordTypeId} using {formulaOptions}.
        slots:
          displayName: requestBody.displayName
          recordTypeId: path.recordTypeId
          formulaOptions: requestBody.formulaOptions
      method: generated
      generated: '2026-10-01'