# 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 Entity Permissions API
  version: 1.0.0
extends: openapi/optimizely-entity-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/EntityPermissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List entity permissions by role
      effect: read
      questions:
      - Which roles have view, edit, create or delete rights on admin entities?
      - Can I filter entity permissions down to one role?
      instructions:
      - text: List all entity permissions.
      - text: Show entity permissions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityPermissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a role permissions on an entity
      effect: write
      questions:
      - How do I give a role edit rights on an admin entity?
      - Can I grant view-only access to a role for one entity configuration?
      instructions:
      - text: Create an entity permission for role {roleName} on entity configuration {entityConfigurationId}.
        slots:
          roleName: requestBody.roleName
          entityConfigurationId: requestBody.entityConfigurationId
      - text: 'Grant role {roleName} permission to delete: {canDelete}.'
        slots:
          roleName: requestBody.roleName
          canDelete: requestBody.canDelete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityPermissions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one entity permission
      effect: read
      questions:
      - How do I look up a single entity permission record?
      - What rights does one entity permission grant?
      instructions:
      - text: Fetch entity permission {id}.
        slots:
          id: path.id
      - text: Show which rights entity permission {id} grants.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityPermissions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an entity permission
      effect: write
      questions:
      - Can I overwrite an entire entity permission record?
      - Does replacing an entity permission reset unspecified rights?
      instructions:
      - text: Replace entity permission {id} for role {roleName}.
        slots:
          id: path.id
          roleName: requestBody.roleName
      - text: Overwrite the full entity permission {id} record.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityPermissions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a single entity permission
      effect: destructive
      questions:
      - How do I remove one entity permission?
      - Can I delete an entity permission only if it hasn't changed?
      instructions:
      - text: Delete entity permission {id}.
        slots:
          id: path.id
      - text: Revoke entity permission {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/EntityPermissions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change specific rights on an entity permission
      effect: write
      questions:
      - Can I toggle just the edit right on an existing permission?
      - Is there a way to take away create access from a role I already set up?
      instructions:
      - text: Set edit access on entity permission {id} to {canEdit}.
        slots:
          id: path.id
          canEdit: requestBody.canEdit
      - text: Set create access on entity permission {id} to {canCreate}.
        slots:
          id: path.id
          canCreate: requestBody.canCreate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityPermissions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new entity permission
      effect: read
      questions:
      - What rights does a new entity permission have by default?
      - Is there a blank entity permission template?
      instructions:
      - text: Get the default values for a new entity permission.
      - text: Show the empty entity permission record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/entitypermissions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several entity permissions at once
      effect: destructive
      questions:
      - How do I bulk delete entity permissions?
      - Can I remove multiple entity permissions by id in one request?
      instructions:
      - text: Bulk delete entity permissions {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every entity permission in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/entitypermissions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an entity permission
      effect: read
      questions:
      - How do I read a custom property on an entity permission?
      - Can I fetch one custom field from an entity permission?
      instructions:
      - text: Get custom property {custompropertyKey} of entity permission {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on entity permission {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'