API Evangelist conversational phrasing for Admin API V1 System Lists API

# 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 Lists API
  version: 1.0.0
extends: openapi/optimizely-system-lists-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: 12
- target: $.paths['/api/v1/admin/SystemLists'].get
  update:
    x-apievangelist-phrasing:
      intent: List and filter system lists
      effect: read
      questions:
      - How can I see all the system lists that drive dropdowns in my commerce admin?
      - Can I filter system lists by name and return only selected fields?
      instructions:
      - text: List all system lists.
      - text: List system lists matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemLists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a system list
      effect: write
      questions:
      - How do I add a new system list of predefined values?
      - What do I need to supply when creating a system list, like additional info?
      instructions:
      - text: Create a system list named {name} described as {description} with additional info {additionalInfo}.
        slots:
          name: requestBody.name
          description: requestBody.description
          additionalInfo: requestBody.additionalInfo
      - text: Add system list {name} ({description}), notes {additionalInfo}, retiring on {deactivateOn}.
        slots:
          name: requestBody.name
          description: requestBody.description
          additionalInfo: requestBody.additionalInfo
          deactivateOn: requestBody.deactivateOn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemLists({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one system list by id
      effect: read
      questions:
      - How can I look up a single system list by its id?
      - Can I expand a system list's values when I fetch it?
      instructions:
      - text: Show system list {id}.
        slots:
          id: path.id
      - text: Fetch system list {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemLists({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a system list entirely
      effect: write
      questions:
      - How do I overwrite every field of a system list in one call?
      - Will a full replace of a system list drop fields I omit?
      instructions:
      - text: Replace system list {id} with name {name}, description {description} and info {additionalInfo}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
          additionalInfo: requestBody.additionalInfo
      - text: Overwrite the full record of system list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemLists({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one system list
      effect: destructive
      questions:
      - How do I remove one system list permanently?
      - Can I guard a system list delete with an If-Match ETag?
      instructions:
      - text: Delete system list {id}.
        slots:
          id: path.id
      - text: Remove system list {id} only if the ETag matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemLists({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update some fields of a system list
      effect: write
      questions:
      - How can I change only the description of a system list?
      - Can I set a deactivation date on a system list without replacing it?
      instructions:
      - text: Update the description of system list {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Deactivate system list {id} on {deactivateOn}.
        slots:
          id: path.id
          deactivateOn: requestBody.deactivateOn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemLists/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new system list
      effect: read
      questions:
      - What defaults does a new system list come with?
      - Where do I grab an empty system list template?
      instructions:
      - text: Fetch the default system list template.
      - text: Show the starting values for new system lists.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemLists/Default.archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive system lists with the archive action
      effect: destructive
      questions:
      - How do I archive system lists using the archive action?
      - Can I retire several system lists without deleting them?
      instructions:
      - text: Archive system lists {ids} via the archive action.
        slots:
          ids: query.ids
      - text: Call the system list archive operation for {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemlists/archive'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive system lists via the DELETE route
      effect: destructive
      questions:
      - Is there a DELETE route for archiving system lists by id?
      - Can I archive system lists through /systemlists/archive?
      instructions:
      - text: Send the archive DELETE for system lists {ids}.
        slots:
          ids: query.ids
      - text: Archive system lists {ids} through the systemlists/archive route.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemlists/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete system lists by ids
      effect: destructive
      questions:
      - How do I delete a batch of system lists at once?
      - Can I pass multiple ids to remove several system lists?
      instructions:
      - text: Bulk delete system lists {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every system list in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemlists({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a system list
      effect: read
      questions:
      - Where can I read a custom property on a system list?
      - How do I fetch one custom attribute stored on a system list?
      instructions:
      - text: Get custom property {custompropertyKey} of system list {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Read custom field {custompropertyKey} on system list {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemlists({key})/values({systemlistvalueKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one value from a system list
      effect: read
      questions:
      - How do I read a single option value inside a system list?
      - Which value entries belong to a given system list?
      instructions:
      - text: Get value {systemlistvalueKey} from system list {key}.
        slots:
          key: path.key
          systemlistvalueKey: path.systemlistvalueKey
      - text: Show list entry {systemlistvalueKey} in system list {key}.
        slots:
          key: path.key
          systemlistvalueKey: path.systemlistvalueKey
      method: generated
      generated: '2026-09-26'