# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Content Item Fields API
  version: 1.0.0
extends: openapi/optimizely-content-item-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: 9
- target: $.paths['/api/v1/admin/ContentItemFields'].get
  update:
    x-apievangelist-phrasing:
      intent: List CMS content item fields
      effect: read
      questions:
      - How can I see all the content item fields stored for my site's CMS content?
      - Can I filter content item fields by field name or language?
      instructions:
      - text: List all content item fields.
      - text: List content item fields matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentItemFields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a content item field
      effect: write
      questions:
      - How do I add a new field value to a content item?
      - What does a content item field need, such as device type and field type?
      instructions:
      - text: Create content field {fieldName} of type {fieldType} for device {deviceType}.
        slots:
          fieldName: requestBody.fieldName
          fieldType: requestBody.fieldType
          deviceType: requestBody.deviceType
      - text: Add field {fieldName} ({fieldType}, device {deviceType}) to content {contentKey} with text {stringValue}.
        slots:
          fieldName: requestBody.fieldName
          fieldType: requestBody.fieldType
          deviceType: requestBody.deviceType
          contentKey: requestBody.contentKey
          stringValue: requestBody.stringValue
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentItemFields({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one content item field
      effect: read
      questions:
      - How can I read a single content item field by its id?
      - Can I see when one content field was approved or published?
      instructions:
      - text: Show content item field {id}.
        slots:
          id: path.id
      - text: Fetch {select} for content item field {id}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentItemFields({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a content item field
      effect: write
      questions:
      - How do I overwrite every property of a content item field?
      - Does a full replace of a content field wipe values I don't include?
      instructions:
      - text: Replace content item field {id} with name {fieldName}, type {fieldType} and device {deviceType}.
        slots:
          id: path.id
          fieldName: requestBody.fieldName
          fieldType: requestBody.fieldType
          deviceType: requestBody.deviceType
      - text: Overwrite the full record of content item field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentItemFields({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one content item field
      effect: destructive
      questions:
      - How do I remove a single content item field?
      - Can I delete a content field only when its ETag hasn't changed?
      instructions:
      - text: Delete content item field {id}.
        slots:
          id: path.id
      - text: Remove content item field {id} if the ETag matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentItemFields({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields of a content item field
      effect: write
      questions:
      - How can I change only the text value of a content field?
      - Can I schedule when an existing content field publishes?
      instructions:
      - text: Set the text of content item field {id} to {stringValue}.
        slots:
          id: path.id
          stringValue: requestBody.stringValue
      - text: Schedule content item field {id} to publish on {publishOn}.
        slots:
          id: path.id
          publishOn: requestBody.publishOn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentItemFields/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get defaults for a new content item field
      effect: read
      questions:
      - What default values does a new content item field get?
      - Where can I get an empty content item field template?
      instructions:
      - text: Fetch the default content item field template.
      - text: Show starting values for a new content field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/contentitemfields/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete content item fields
      effect: destructive
      questions:
      - How do I delete many content item fields at once?
      - Can I pass a list of ids to clear several content fields?
      instructions:
      - text: Bulk delete content item fields {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every content field in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/contentitemfields({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a content item field
      effect: read
      questions:
      - Where can I read a custom property on a content item field?
      - How do I fetch one custom attribute from a content field?
      instructions:
      - text: Get custom property {custompropertyKey} of content item field {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Read custom attribute {custompropertyKey} on content field {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'