API Evangelist conversational phrasing for Admin API V1 Admin Action Permissions 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 Admin Action Permissions API
  version: 1.0.0
extends: openapi/optimizely-admin-action-permissions-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: 9
- target: $.paths['/api/v1/admin/AdminActionPermissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin action permissions
      effect: read
      questions:
      - Which roles are allowed to run which admin actions in my commerce admin console?
      - Can I filter or page through admin action permissions with OData query options?
      - What does the full list of admin action permission records look like?
      instructions:
      - text: List all admin action permissions.
      - text: List admin action permissions matching the filter {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} admin action permissions sorted by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionPermissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a role permission for an admin action
      effect: write
      questions:
      - How do I give a role permission to perform an admin action?
      - Can I create a new admin action permission tied to a specific action configuration?
      instructions:
      - text: Grant role {roleName} a {permissionType} permission on admin action configuration {adminActionConfigurationId}.
        slots:
          roleName: requestBody.roleName
          permissionType: requestBody.permissionType
          adminActionConfigurationId: requestBody.adminActionConfigurationId
      - text: Create a new admin action permission of type {permissionType} for role {roleName}.
        slots:
          permissionType: requestBody.permissionType
          roleName: requestBody.roleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionPermissions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one admin action permission
      effect: read
      questions:
      - What role and permission type does a specific admin action permission record hold?
      - Can I look up a single admin action permission by its ID?
      instructions:
      - text: Get admin action permission {id}.
        slots:
          id: path.id
      - text: Show admin action permission {id} with related {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionPermissions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an admin action permission
      effect: write
      questions:
      - Is there a way to overwrite an entire admin action permission record in one go?
      - What happens if I replace an admin action permission rather than patching it?
      instructions:
      - text: Replace admin action permission {id} with role {roleName} and permission type {permissionType}.
        slots:
          id: path.id
          roleName: requestBody.roleName
          permissionType: requestBody.permissionType
      - text: Overwrite the whole admin action permission record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionPermissions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one admin action permission
      effect: destructive
      questions:
      - How do I revoke a single admin action permission from a role?
      - Can I delete one admin action permission by ID with an If-Match check?
      instructions:
      - text: Delete admin action permission {id}.
        slots:
          id: path.id
      - text: Revoke the admin action permission record {id} only if it matches ETag {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionPermissions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields of an admin action permission
      effect: write
      questions:
      - Can I change just the role on an existing admin action permission?
      - How do I modify the permission type of an admin action permission already in place?
      instructions:
      - text: Change the role on admin action permission {id} to {roleName}, keeping permission type {permissionType}.
        slots:
          id: path.id
          roleName: requestBody.roleName
          permissionType: requestBody.permissionType
      - text: Patch admin action permission {id} to permission type {permissionType} for role {roleName}.
        slots:
          id: path.id
          permissionType: requestBody.permissionType
          roleName: requestBody.roleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminActionPermissions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on admin action permissions
      effect: read
      questions:
      - What does the Default function on the admin action permissions entity set return?
      - Is there a Default operation I can call for admin action permissions?
      instructions:
      - text: Call the Default function on admin action permissions.
      - text: Run the admin action permissions Default operation and show the result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminactionpermissions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete admin action permissions by ID
      effect: destructive
      questions:
      - Can I delete several admin action permissions in one request?
      - How do I remove a batch of admin action permissions by their IDs?
      instructions:
      - text: Delete the admin action permissions with IDs {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove admin action permissions {ids} at once.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminactionpermissions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of an admin action permission
      effect: read
      questions:
      - How can I read a custom property stored on an admin action permission?
      - Do admin action permissions carry custom properties I can fetch by key?
      instructions:
      - text: Get custom property {custompropertyKey} of admin action permission {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the value of custom property {custompropertyKey} on admin action permission {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'