# 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 Property Permissions API
  version: 1.0.0
extends: openapi/optimizely-property-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/PropertyPermissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List field-level property permissions
      effect: read
      questions:
      - How do I see which admin roles can view or edit each configured property?
      - Can I filter property permissions to one role name?
      instructions:
      - text: List all property permissions.
      - text: List property permissions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyPermissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a role access to a property
      effect: write
      questions:
      - How do I let a role view but not edit a specific property?
      - What is required to create a property permission for a role?
      instructions:
      - text: Grant role {roleName} view access {canView} and edit access {canEdit} on property configuration {propertyConfigurationId}.
        slots:
          roleName: requestBody.roleName
          canView: requestBody.canView
          canEdit: requestBody.canEdit
          propertyConfigurationId: requestBody.propertyConfigurationId
      - text: Create a property permission for role {roleName}.
        slots:
          roleName: requestBody.roleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyPermissions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one property permission
      effect: read
      questions:
      - How do I check the view and edit flags on a single property permission?
      - Can I fetch a property permission by its ID?
      instructions:
      - text: Get property permission {id}.
        slots:
          id: path.id
      - text: Show whether property permission {id} allows viewing and editing.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyPermissions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a property permission
      effect: write
      questions:
      - How do I overwrite a whole property permission record?
      - Is there a way to fully replace a role's property permission instead of patching it?
      instructions:
      - text: Replace property permission {id} for role {roleName} with canEdit {canEdit}.
        slots:
          id: path.id
          roleName: requestBody.roleName
          canEdit: requestBody.canEdit
      - text: Overwrite property permission {id} with a complete record for role {roleName}.
        slots:
          id: path.id
          roleName: requestBody.roleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyPermissions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a property permission
      effect: destructive
      questions:
      - How do I remove a role's permission on a property?
      - Can I delete a property permission only if its ETag still matches?
      instructions:
      - text: Delete property permission {id}.
        slots:
          id: path.id
      - text: Remove property permission {id} if its ETag is still {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyPermissions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a role's view or edit rights on a property
      effect: write
      questions:
      - How do I revoke edit rights on a property for a role without deleting the permission?
      - Can I flip just the canView flag on an existing property permission?
      instructions:
      - text: Set canEdit to {canEdit} on property permission {id}.
        slots:
          canEdit: requestBody.canEdit
          id: path.id
      - text: Set canView to {canView} on property permission {id}.
        slots:
          canView: requestBody.canView
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyPermissions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank property permission template
      effect: read
      questions:
      - What default values does a new property permission start with?
      - Can I fetch an empty property permission template before creating one?
      instructions:
      - text: Fetch the default property permission template.
      - text: Show me the starting values for a new property permission.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/propertypermissions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete property permissions
      effect: destructive
      questions:
      - How do I delete several property permissions at once?
      - Can I remove a batch of property permissions by ID?
      instructions:
      - text: Bulk delete the property permissions with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these property permissions in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/propertypermissions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a property permission
      effect: read
      questions:
      - How do I read a custom property stored on a property permission record?
      - Can I fetch one extra field value from a property permission?
      instructions:
      - text: Get custom property {custompropertyKey} on property permission {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of permission record {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'