Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely List Attributes API

6 actions 6 updates phrasing extends openapi/optimizely-list-attributes-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/list_attributes'].get
$.paths['/list_attributes'].post
$.paths['/list_attributes/{list_attribute_id}'].get
$.paths['/list_attributes/{list_attribute_id}'].delete
$.paths['/list_attributes/{list_attribute_id}'].patch

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 Optimizely List Attributes API
  version: 1.0.0
extends: openapi/optimizely-list-attributes-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: 5
- target: $.paths['/list_attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's list attributes
      effect: read
      questions:
      - Which uploaded targeting lists exist in my project?
      - Can I see every List Attribute created for a given project?
      instructions:
      - text: List the List Attributes in project {project_id}.
        slots:
          project_id: query.project_id
      - text: Show all targeting lists uploaded to project {project_id}.
        slots:
          project_id: query.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/list_attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a list attribute for audience targeting
      effect: write
      questions:
      - How do I upload a list of user IDs or ZIP codes to target an audience?
      - Which list types can a List Attribute match against, like cookies or query parameters?
      - Can I supply the list content inline as a comma separated string?
      instructions:
      - text: Create List Attribute {name} in project {project_id} keyed on {key_field}.
        slots:
          name: requestBody.name
          project_id: requestBody.project_id
          key_field: requestBody.key_field
      - text: Create a {list_type} list {name} in project {project_id} matching {key_field} against {list_content}.
        slots:
          list_type: requestBody.list_type
          name: requestBody.name
          project_id: requestBody.project_id
          key_field: requestBody.key_field
          list_content: requestBody.list_content
      method: generated
      generated: '2026-09-26'
- target: $.paths['/list_attributes/{list_attribute_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a list attribute's metadata
      effect: read
      questions:
      - What key field and list type does a particular List Attribute use?
      - Where is the S3 path for a List Attribute's data?
      instructions:
      - text: Get List Attribute {list_attribute_id}.
        slots:
          list_attribute_id: path.list_attribute_id
      - text: Show the metadata of targeting list {list_attribute_id}.
        slots:
          list_attribute_id: path.list_attribute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/list_attributes/{list_attribute_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a list attribute
      effect: destructive
      questions:
      - How do I retire a targeting list I no longer use?
      - Can I archive a List Attribute by its ID?
      instructions:
      - text: Archive List Attribute {list_attribute_id}.
        slots:
          list_attribute_id: path.list_attribute_id
      - text: Retire targeting list {list_attribute_id}.
        slots:
          list_attribute_id: path.list_attribute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/list_attributes/{list_attribute_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a list attribute
      effect: write
      questions:
      - Can I replace the IDs inside an existing targeting list?
      - How do I rename a List Attribute or change its key field?
      instructions:
      - text: Replace the contents of List Attribute {list_attribute_id} with {list_content}.
        slots:
          list_attribute_id: path.list_attribute_id
          list_content: requestBody.list_content
      - text: Rename List Attribute {list_attribute_id} to {name}.
        slots:
          list_attribute_id: path.list_attribute_id
          name: requestBody.name
      - text: Change the key field of List Attribute {list_attribute_id} to {key_field}.
        slots:
          list_attribute_id: path.list_attribute_id
          key_field: requestBody.key_field
      method: generated
      generated: '2026-09-26'