# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Optimizely CMP Open API Documentation Fields API
  version: 1.0.0
extends: openapi/optimizely-fields-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: 6
- target: $.paths['/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's custom fields
      effect: read
      questions:
      - Which custom fields are defined in my Optimizely CMP organization?
      - Can I page through the organization's fields with an offset and page size?
      - Is there a way to fetch only certain fields by their IDs?
      instructions:
      - text: List all fields in my CMP organization.
      - text: Get the fields with IDs {ids}.
        slots:
          ids: query.ids
      - text: List {page_size} fields starting at offset {offset}.
        slots:
          page_size: query.page_size
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new field to the organization
      effect: write
      questions:
      - How do I add a new custom field to my CMP organization?
      - Can I create an organization-wide field through the experimental fields endpoint?
      instructions:
      - text: Create a new field in my CMP organization.
      - text: Add a custom field to the organization's field list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fields/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an organization field
      effect: write
      questions:
      - How do I change an existing field's settings in CMP?
      - Can I edit a field definition after it has been created?
      instructions:
      - text: Update field {id}.
        slots:
          id: path.id
      - text: Edit the settings of CMP field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fields/{id}/choices'].post
  update:
    x-apievangelist-phrasing:
      intent: Add choices to a field
      effect: write
      questions:
      - How do I add dropdown options to a choice field?
      - Can I create several new choices on one field at once?
      instructions:
      - text: Add new choices to field {id}.
        slots:
          id: path.id
      - text: Create options on choice field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fields/{field_id}/choices/{choice_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a choice from a field
      effect: destructive
      questions:
      - Can I remove a single option from a choice field?
      - What happens when I delete one of a field's choices?
      instructions:
      - text: Delete choice {choice_id} from field {field_id}.
        slots:
          choice_id: path.choice_id
          field_id: path.field_id
      - text: Remove option {choice_id} on field {field_id}.
        slots:
          choice_id: path.choice_id
          field_id: path.field_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fields/{field_id}/choices/{choice_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a field's choice
      effect: write
      questions:
      - How do I rename one option on a choice field?
      - Can I edit an existing choice without deleting it?
      instructions:
      - text: Update choice {choice_id} on field {field_id}.
        slots:
          choice_id: path.choice_id
          field_id: path.field_id
      - text: Edit option {choice_id} of field {field_id}.
        slots:
          choice_id: path.choice_id
          field_id: path.field_id
      method: generated
      generated: '2026-09-26'