# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Custom Field…
  version: 1.0.0
extends: openapi/atlassian-issue-custom-field-options-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['/rest/api/3/customFieldOption/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom field option by ID
      effect: read
      questions:
      - What value does a given select list option ID hold?
      - Does looking up an option by ID work for Connect app options?
      instructions:
      - text: Get custom field option {id}.
        slots:
          id: path.id
      - text: Show the value of select list option {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/option'].get
  update:
    x-apievangelist-phrasing:
      intent: List a custom field's options in a context
      effect: read
      questions:
      - Which dropdown options does a custom field offer in a particular context?
      - Can I exclude cascading options and see only top-level ones?
      instructions:
      - text: List options of field {fieldId} in context {contextId}.
        slots:
          fieldId: path.fieldId
          contextId: path.contextId
      - text: List only top-level options of field {fieldId} in context {contextId} ({onlyOptions}).
        slots:
          fieldId: path.fieldId
          contextId: path.contextId
          onlyOptions: query.onlyOptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/option'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit existing custom field options
      effect: write
      questions:
      - How do I rename or disable existing options in a select field?
      - What happens if one of the options I update can't be found?
      instructions:
      - text: Update options {options} of field {fieldId} in context {contextId}.
        slots:
          options: requestBody.options
          fieldId: path.fieldId
          contextId: path.contextId
      - text: Change the existing option values of field {fieldId} context {contextId} to {options}.
        slots:
          fieldId: path.fieldId
          contextId: path.contextId
          options: requestBody.options
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/option'].post
  update:
    x-apievangelist-phrasing:
      intent: Add new options to a custom select field
      effect: write
      questions:
      - Can I add new choices, including cascading ones, to a select field?
      - Is there a limit on how many options I can add per request?
      instructions:
      - text: Add options {options} to field {fieldId} in context {contextId}.
        slots:
          options: requestBody.options
          fieldId: path.fieldId
          contextId: path.contextId
      - text: Create new dropdown choices {options} for field {fieldId} context {contextId}.
        slots:
          options: requestBody.options
          fieldId: path.fieldId
          contextId: path.contextId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/option/move'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder custom field options
      effect: write
      questions:
      - How do I move select options to the top or bottom of the list?
      - Can I place options after a specific other option?
      instructions:
      - text: Move options {customFieldOptionIds} of field {fieldId} context {contextId} to {position}.
        slots:
          customFieldOptionIds: requestBody.customFieldOptionIds
          fieldId: path.fieldId
          contextId: path.contextId
          position: requestBody.position
      - text: Place options {customFieldOptionIds} after option {after} in field {fieldId} context {contextId}.
        slots:
          customFieldOptionIds: requestBody.customFieldOptionIds
          after: requestBody.after
          fieldId: path.fieldId
          contextId: path.contextId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field option
      effect: destructive
      questions:
      - Can I delete a select option that still has cascading children?
      - How do I remove a single choice from a dropdown field?
      instructions:
      - text: Delete option {optionId} from field {fieldId} in context {contextId}.
        slots:
          optionId: path.optionId
          fieldId: path.fieldId
          contextId: path.contextId
      - text: Remove choice {optionId} from field {fieldId} context {contextId}.
        slots:
          optionId: path.optionId
          fieldId: path.fieldId
          contextId: path.contextId
      method: generated
      generated: '2026-10-01'