API Evangelist conversational phrasing for Admin API V1 System Settings 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 Settings API
  version: 1.0.0
extends: openapi/optimizely-system-settings-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: 18
- target: $.paths['/api/v1/admin/SystemSettings'].get
  update:
    x-apievangelist-phrasing:
      intent: List system settings
      effect: read
      questions:
      - How do I see every system setting configured in my Optimizely Configured Commerce admin?
      - Can I filter the system settings list down to ones whose name matches a condition?
      instructions:
      - text: List all system settings.
      - text: List system settings matching the filter {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} system settings sorted by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemSettings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a system setting
      effect: write
      questions:
      - How do I add a new named system setting with a value?
      - Can a new system setting be scoped to a single website?
      instructions:
      - text: Create a system setting named {name} with value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Add system setting {name} = {value} for website {websiteId}.
        slots:
          name: requestBody.name
          value: requestBody.value
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemSettings({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a system setting by its id
      effect: read
      questions:
      - What value does the system setting with a given id currently hold?
      - Can I fetch one system setting record using its GUID id?
      instructions:
      - text: Get the system setting with id {id}.
        slots:
          id: path.id
      - text: Show the name and value of system setting record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemSettings({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a system setting
      effect: write
      questions:
      - How do I overwrite an entire system setting record rather than patching one field?
      - Can I fully replace a system setting's name and value in one call?
      instructions:
      - text: Replace system setting {id} with name {name} and value {value}.
        slots:
          id: path.id
          name: requestBody.name
          value: requestBody.value
      - text: Fully overwrite the record for system setting {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemSettings({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a system setting
      effect: destructive
      questions:
      - How do I remove a single system setting by its id?
      - Can I guard a system setting deletion with an ETag so I don't delete a changed record?
      instructions:
      - text: Delete system setting {id}.
        slots:
          id: path.id
      - text: Delete system setting {id} only if its ETag still matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemSettings({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a system setting's value
      effect: write
      questions:
      - How do I change the value of an existing system setting?
      - Can I partially update a system setting without resending the whole record?
      instructions:
      - text: Update system setting {id} to value {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Patch system setting {id} so it applies to website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemSettings/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank default system setting
      effect: read
      questions:
      - What does an empty system setting record look like before I fill it in?
      - Is there a default template object for a new system setting?
      instructions:
      - text: Get the default template for a new system setting.
      - text: Show me the blank default system setting object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemSettings/Default.batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Save many settings via the Default.batch action
      effect: write
      questions:
      - Can I save a whole set of settings for a website in one OData batch action?
      - How do I bulk-set settings using the Default.batch operation?
      instructions:
      - text: Save settings {settings} for website {websiteId} using the Default.batch action.
        slots:
          settings: requestBody.settings
          websiteId: requestBody.websiteId
      - text: Run the OData Default.batch action with settings {settings}.
        slots:
          settings: requestBody.settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemSettings/Default.restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore settings via the Default.restore action
      effect: write
      questions:
      - How do I restore a group of settings for a website with the Default.restore action?
      - Can I roll listed settings back using the OData restore operation?
      instructions:
      - text: Restore settings {settings} for website {websiteId} with the Default.restore action.
        slots:
          settings: requestBody.settings
          websiteId: requestBody.websiteId
      - text: Call the OData Default.restore action for settings {settings}.
        slots:
          settings: requestBody.settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemSettings/Default.test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a settings group via Default.test
      effect: read
      questions:
      - Can I test a settings group's configuration before relying on it?
      - How do I run the Default.test action against a specific settings group?
      instructions:
      - text: Test settings group {settingsGroup} using the Default.test action.
        slots:
          settingsGroup: requestBody.settingsGroup
      - text: Run the OData Default.test check on settings group {settingsGroup}.
        slots:
          settingsGroup: requestBody.settingsGroup
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SystemSettings/Default.Groups(websiteId={websiteId})'].get
  update:
    x-apievangelist-phrasing:
      intent: List setting groups via the Default.Groups function
      effect: read
      questions:
      - Which settings groups exist for a given website, via the OData Default.Groups function?
      - How do I call Default.Groups to see a website's setting groups?
      instructions:
      - text: Get setting groups for website {websiteId} using the Default.Groups function.
        slots:
          websiteId: path.websiteId
      - text: Call Default.Groups for website {websiteId}.
        slots:
          websiteId: path.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemsettings({key})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a system setting by key
      effect: read
      questions:
      - How do I look up a system setting using its key on the lowercase systemsettings route?
      - Can I fetch a setting by key and pick only certain properties?
      instructions:
      - text: Get the system setting with key {key}.
        slots:
          key: path.key
      - text: Look up system setting key {key} and return only {select}.
        slots:
          key: path.key
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemsettings/groups(websiteId={websiteId})'].get
  update:
    x-apievangelist-phrasing:
      intent: List setting groups on the plain groups route
      effect: read
      questions:
      - What setting groups does a website have, using the lowercase systemsettings/groups route?
      - Is there a non-OData-action route to list a website's settings groups?
      instructions:
      - text: List settings groups for website {websiteId} from the systemsettings/groups route.
        slots:
          websiteId: path.websiteId
      - text: Fetch website {websiteId}'s setting groups via the plain groups endpoint.
        slots:
          websiteId: path.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemsettings/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test settings on the plain test route
      effect: read
      questions:
      - Is there a parameterless systemsettings/test route for checking settings?
      - Can I trigger a settings test through the lowercase test endpoint?
      instructions:
      - text: Run a settings test through the plain systemsettings/test route.
      - text: Call the lowercase settings test endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemsettings/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Save settings on the plain batch route
      effect: write
      questions:
      - Is there a plain systemsettings/batch route, separate from the Default.batch action?
      - Can I post a settings batch to the lowercase batch endpoint?
      instructions:
      - text: Post a settings batch to the plain systemsettings/batch route.
      - text: Save settings in bulk through the lowercase batch endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemsettings/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore settings on the plain restore route
      effect: write
      questions:
      - Is there a plain systemsettings/restore route besides the Default.restore action?
      - Can I restore settings by posting to the lowercase restore endpoint?
      instructions:
      - text: Restore settings through the plain systemsettings/restore route.
      - text: Call the lowercase settings restore endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemsettings/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several system settings at once
      effect: destructive
      questions:
      - How do I delete multiple system settings in a single request?
      - Can I bulk-remove system settings by passing a list of ids?
      instructions:
      - text: Delete the system settings with ids {ids}.
        slots:
          ids: query.ids
      - text: Bulk-remove system settings {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/systemsettings({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a system setting
      effect: read
      questions:
      - Can system settings carry custom properties, and how do I read one?
      - How do I fetch one custom property attached to a system setting?
      instructions:
      - text: Get custom property {custompropertyKey} on system setting {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the value of custom property {custompropertyKey} for setting {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'