API Evangelist conversational phrasing for User Management Object Permission API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for User Management Object Permission API
  version: 1.0.0
extends: openapi/conga-object-permission-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/api/user-management/v1/objectpermissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List object permissions
      effect: read
      questions:
      - What object permissions are configured?
      - Can I filter object permissions by criteria?
      instructions:
      - text: List all object permissions.
      - text: Show object permissions matching {criteria}.
        slots:
          criteria: query.criteria
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/objectpermissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an object permission
      effect: write
      questions:
      - How do I give a permission group access to an object?
      - Can I grant view-all or modify-all on an object?
      instructions:
      - text: Grant group {group} permission on object {object}.
        slots:
          group: requestBody.PermissionGroupName
          object: requestBody.ObjectName
      - text: Give {group} view-all {view} on {object}.
        slots:
          group: requestBody.PermissionGroupName
          view: requestBody.ViewAll
          object: requestBody.ObjectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/objectpermissions/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create object permissions in bulk
      effect: write
      questions:
      - Can I create many object permissions at once?
      - How do I bulk-grant object access?
      instructions:
      - text: Bulk create object permissions.
      - text: Grant several object permissions in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/objectpermissions/bulk'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete object permissions in bulk
      effect: destructive
      questions:
      - Can I remove many object permissions at once?
      - How do I bulk-revoke object access?
      instructions:
      - text: Bulk delete the selected object permissions.
      - text: Revoke several object permissions in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/objectpermissions/objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List objects available for permissions
      effect: read
      questions:
      - Which objects can I set permissions on?
      - Can I search permissionable objects by prefix?
      instructions:
      - text: List objects available for object permissions.
      - text: Show permissionable objects starting with {prefix}.
        slots:
          prefix: query.startsWithFilter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/objectpermissions/objects/{objectName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get permissions for an object
      effect: read
      questions:
      - Who has access to a given object?
      - What permission details exist for one object name?
      instructions:
      - text: Get object permission details for {object}.
        slots:
          object: path.objectName
      - text: Show which groups can access {object}.
        slots:
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/objectpermissions/{objectName}/actionpermissions/{actionName}/validate'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an action permission on an object
      effect: read
      questions:
      - Am I allowed to perform a given action on an object?
      - Can I validate an action permission before calling it?
      instructions:
      - text: Check whether action {action} is permitted on {object}.
        slots:
          action: path.actionName
          object: path.objectName
      - text: Validate permission for {action} on object {object}.
        slots:
          action: path.actionName
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/objectpermissions/{objectPermissionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object permission by ID
      effect: read
      questions:
      - Where can I see one object permission record?
      - What does a specific object permission grant?
      instructions:
      - text: Get object permission {id}.
        slots:
          id: path.objectPermissionId
      - text: Show object permission record {id}.
        slots:
          id: path.objectPermissionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/objectpermissions/{objectPermissionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an object permission
      effect: write
      questions:
      - How do I change an existing object permission?
      - Can I add modify-all to an object permission?
      instructions:
      - text: Update object permission {id}.
        slots:
          id: path.objectPermissionId
      - text: Set modify-all {modify} on object permission {id}.
        slots:
          modify: requestBody.ModifyAll
          id: path.objectPermissionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/objectpermissions/{objectPermissionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an object permission
      effect: destructive
      questions:
      - Can I remove one object permission?
      - What happens when a group's object permission is deleted?
      instructions:
      - text: Delete object permission {id}.
        slots:
          id: path.objectPermissionId
      - text: Revoke object permission record {id}.
        slots:
          id: path.objectPermissionId
      method: generated
      generated: '2026-10-01'