# 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 System List Values API
  version: 1.0.0
extends: openapi/optimizely-system-list-values-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: 11
- target: $.paths['/api/v1/admin/SystemListValues'].get
  update:
    x-apievangelist-phrasing:
      intent: List system list values
      effect: read
      questions:
      - How do I see all the dropdown values stored in system lists in Optimizely Configured Commerce?
      - Can I filter system list values to one list and count them?
      instructions:
      - text: List all system list values.
      - text: List system list values matching {filter} with a total count.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemListValues'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a value to a system list
      effect: write
      questions:
      - What's needed to add a new option to a system list?
      - Can I set a deactivation date on a system list value when I create it?
      instructions:
      - text: Add value {name} to system list {systemListId} with description {description}.
        slots:
          name: requestBody.name
          systemListId: requestBody.systemListId
          description: requestBody.description
      - text: Create system list value {name} with additional info {additionalInfo}.
        slots:
          name: requestBody.name
          additionalInfo: requestBody.additionalInfo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemListValues({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one system list value
      effect: read
      questions:
      - How can I look up a single system list value by its ID?
      - Which fields can I select when reading one system list value?
      instructions:
      - text: Show system list value {id}.
        slots:
          id: path.id
      - text: Get system list value {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemListValues({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a system list value
      effect: write
      questions:
      - Can I overwrite a system list value with a whole new record?
      - Do I need to resend the name and description when replacing a list value?
      instructions:
      - text: Replace system list value {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      - text: Overwrite all fields of system list value {id}, moving it to list {systemListId}.
        slots:
          id: path.id
          systemListId: requestBody.systemListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemListValues({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a system list value
      effect: destructive
      questions:
      - How do I delete one value from a system list?
      - Can I delete a list value conditionally using an ETag?
      instructions:
      - text: Delete system list value {id}.
        slots:
          id: path.id
      - text: Delete system list value {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemListValues({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update part of a system list value
      effect: write
      questions:
      - Can I set just the deactivation date on an existing system list value?
      - How do I edit only the description of a list value?
      instructions:
      - text: Patch system list value {id} to deactivate on {deactivateOn}.
        slots:
          id: path.id
          deactivateOn: requestBody.deactivateOn
      - text: Update system list value {id} description to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemListValues/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a system list value
      effect: read
      questions:
      - What defaults are pre-filled for a new system list value?
      - Is there a blank system list value template?
      instructions:
      - text: Get the default system list value template.
      - text: Show pre-filled values for a new system list value.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemListValues/Default.archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive system list values (OData action)
      effect: write
      questions:
      - Can I archive list values with the Default.archive POST action?
      - How do I archive system list values using a POST call?
      instructions:
      - text: Archive system list values {ids} with the Default.archive action.
        slots:
          ids: query.ids
      - text: POST to the system list value archive action for {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemlistvalues/archive'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive system list values (DELETE route)
      effect: destructive
      questions:
      - Is there a DELETE systemlistvalues/archive route?
      - Which endpoint archives list values using the DELETE verb?
      instructions:
      - text: Archive system list values {ids} through the DELETE archive route.
        slots:
          ids: query.ids
      - text: Send a DELETE to systemlistvalues/archive for {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemlistvalues/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several system list values
      effect: destructive
      questions:
      - Can I bulk delete a set of system list values?
      - How do I permanently remove many list values at once?
      instructions:
      - text: Bulk delete system list values {ids}.
        slots:
          ids: query.ids
      - text: Permanently remove the system list values in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemlistvalues({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a system list value
      effect: read
      questions:
      - Can I read a custom property attached to a system list value?
      - Where are extra attributes on a list value stored?
      instructions:
      - text: Get custom property {custompropertyKey} on system list value {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show system list value {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'