API Evangelist conversational phrasing for User Management Field 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 Field Permission API
  version: 1.0.0
extends: openapi/conga-field-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: 8
- target: $.paths['/api/user-management/v1/field-permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get field permissions for an object and group
      effect: read
      questions:
      - What field access does a permission group have on an object?
      - Can I filter field permissions by access type?
      instructions:
      - text: Get field permissions on {object} for permission group {group}.
        slots:
          object: query.objectName
          group: query.permissionGroupName
      - text: Show fields on {object} with {access} access.
        slots:
          object: query.objectName
          access: query.accessType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/field-permissions'].put
  update:
    x-apievangelist-phrasing:
      intent: Update field permissions by group and object
      effect: write
      questions:
      - How do I change field access for a group on an object?
      - Can I update permissions without knowing the permission ID?
      instructions:
      - text: Update field access on {object} for group {group} to {access}.
        slots:
          object: requestBody.ObjectName
          group: requestBody.PermissionGroupName
          access: requestBody.FieldLevelAccess
      - text: Change the existing field-level access of {group} on {object}.
        slots:
          group: requestBody.PermissionGroupName
          object: requestBody.ObjectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/field-permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Set field permissions
      effect: write
      questions:
      - How do I grant a permission group field access on an object for the first time?
      - Which fields can I make read-only for a group?
      instructions:
      - text: Set new field permissions {access} for group {group} on {object}.
        slots:
          access: requestBody.FieldLevelAccess
          group: requestBody.PermissionGroupName
          object: requestBody.ObjectName
      - text: Grant {group} field-level access on object {object}.
        slots:
          group: requestBody.PermissionGroupName
          object: requestBody.ObjectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/field-permissions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete field permissions by group and object
      effect: destructive
      questions:
      - Can I remove a group's field permissions on an object?
      - How do I clear field access by object and group name?
      instructions:
      - text: Delete field permissions of group {group} on {object}.
        slots:
          group: query.permissionGroupName
          object: query.objectName
      - text: Remove all field access for {group} on object {object}.
        slots:
          group: query.permissionGroupName
          object: query.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/field-permissions/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Set multiple field permissions in bulk
      effect: write
      questions:
      - Can I set field permissions for many objects or groups at once?
      - Is there a bulk endpoint for field permissions?
      instructions:
      - text: Bulk set field permissions for several groups.
      - text: Apply many field permission entries in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/field-permissions/{fieldPermissionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field permission by ID
      effect: read
      questions:
      - Where can I see one field permission record?
      - What access does a specific field permission grant?
      instructions:
      - text: Get field permission {id}.
        slots:
          id: path.fieldPermissionId
      - text: Show field permission record {id}.
        slots:
          id: path.fieldPermissionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/field-permissions/{fieldPermissionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a field permission by ID
      effect: write
      questions:
      - How do I edit a single field permission record?
      - Can I change access on one field permission I already have the ID for?
      instructions:
      - text: Update field permission {id} to access {access}.
        slots:
          id: path.fieldPermissionId
          access: requestBody.FieldLevelAccess
      - text: Change field permission record {id}.
        slots:
          id: path.fieldPermissionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/field-permissions/{fieldPermissionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field permission by ID
      effect: destructive
      questions:
      - Can I delete one field permission record by its ID?
      - What happens when a field permission is removed?
      instructions:
      - text: Delete field permission {id}.
        slots:
          id: path.fieldPermissionId
      - text: Remove field permission record {id}.
        slots:
          id: path.fieldPermissionId
      method: generated
      generated: '2026-10-01'