# 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 Admin Action Configurations API
  version: 1.0.0
extends: openapi/optimizely-admin-action-configurations-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: 10
- target: $.paths['/api/v1/admin/AdminActionConfigurations'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin action configurations
      effect: read
      questions:
      - How do I list the configured admin console actions?
      - Can I filter admin action configurations by form name?
      instructions:
      - text: List all admin action configurations.
      - text: List admin action configurations matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionConfigurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an admin action configuration
      effect: write
      questions:
      - How do I add a custom action button to an admin form?
      - Can I set a label, tooltip and permission type when creating an admin action?
      instructions:
      - text: Create admin action {name} on form {formName} labeled {label}.
        slots:
          name: requestBody.name
          formName: requestBody.formName
          label: requestBody.label
      - text: Add an admin action {name} with tooltip {toolTip} and permission type {permissionType}.
        slots:
          name: requestBody.name
          toolTip: requestBody.toolTip
          permissionType: requestBody.permissionType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionConfigurations({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one admin action configuration
      effect: read
      questions:
      - How do I look up a single admin action configuration by its id?
      - What form and permission type does a given admin action use?
      instructions:
      - text: Get admin action configuration {id}.
        slots:
          id: path.id
      - text: Show the label and form for admin action {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionConfigurations({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an admin action configuration
      effect: write
      questions:
      - How do I overwrite an admin action configuration completely?
      - Is there a full-replace call for admin actions?
      instructions:
      - text: Replace admin action configuration {id} with name {name} on form {formName}.
        slots:
          id: path.id
          name: requestBody.name
          formName: requestBody.formName
      - text: Overwrite the whole admin action record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionConfigurations({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an admin action configuration
      effect: destructive
      questions:
      - How do I remove a single admin action configuration?
      - Can I delete an admin action only if the ETag still matches?
      instructions:
      - text: Delete admin action configuration {id}.
        slots:
          id: path.id
      - text: Delete admin action {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionConfigurations({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on an admin action configuration
      effect: write
      questions:
      - How do I change just the tooltip text of an admin action?
      - Can I rename an admin action's label without replacing the record?
      instructions:
      - text: Change the tooltip of admin action {id} to {toolTip}.
        slots:
          id: path.id
          toolTip: requestBody.toolTip
      - text: Patch admin action {id} so its label reads {label}.
        slots:
          id: path.id
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionConfigurations/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default admin action configuration
      effect: read
      questions:
      - What are the default values for a new admin action configuration?
      - Can I see the blank admin action template?
      instructions:
      - text: Get the default admin action configuration.
      - text: Show the template for a new admin action.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminactionconfigurations/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete admin action configurations
      effect: destructive
      questions:
      - How do I delete several admin action configurations at once?
      - Can I bulk remove admin actions by a list of ids?
      instructions:
      - text: Bulk delete admin action configurations {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these admin actions in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminactionconfigurations({key})/actionpermissions({adminactionpermissionKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a permission on an admin action
      effect: read
      questions:
      - Which roles have permission to run a given admin action?
      - How do I look up one action permission tied to an admin action configuration?
      instructions:
      - text: Get action permission {adminactionpermissionKey} on admin action {key}.
        slots:
          adminactionpermissionKey: path.adminactionpermissionKey
          key: path.key
      - text: Show who admin action {key} permission {adminactionpermissionKey} grants access to.
        slots:
          key: path.key
          adminactionpermissionKey: path.adminactionpermissionKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminactionconfigurations({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an admin action
      effect: read
      questions:
      - How do I read a custom property stored on an admin action configuration?
      - Can I fetch one extension property of an admin action?
      instructions:
      - text: Get custom property {custompropertyKey} on admin action {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the value of custom property {custompropertyKey} for admin action {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'