# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Cloud REST API v2 Space Permission Transition API
  version: 1.0.0
extends: openapi/confluence-space-permission-transition-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: 5
- target: $.paths['/space-permissions/transition/combinations'].get
  update:
    x-apievangelist-phrasing:
      intent: List unassigned space permission combinations
      effect: read
      questions:
      - Which space permission combinations still are not mapped to a space role?
      - What permission sets need roles before I move to role-based access?
      instructions:
      - text: List the unassigned space permission combinations.
      - text: Show the next {limit} permission combinations without a role.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/space-permissions/transition/combinations'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh space permission combinations
      effect: write
      questions:
      - How do I scan the site for every unique space permission combination?
      - Can I regenerate the permission combination ids before assigning roles?
      instructions:
      - text: Generate a fresh set of space permission combinations for the site.
      - text: Start a task to recompute the space permission combinations.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/space-permissions/transition/role-assignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk assign roles to permission combinations
      effect: write
      questions:
      - How do I map old space permission combinations to roles in bulk?
      - Can I apply role assignments to all spaces except a few?
      instructions:
      - text: Assign roles {assignments} across spaces {spaceSelection}.
        slots:
          assignments: requestBody.assignments
          spaceSelection: requestBody.spaceSelection
      - text: Bulk apply role mappings {assignments} to the space selection {spaceSelection}.
        slots:
          assignments: requestBody.assignments
          spaceSelection: requestBody.spaceSelection
      method: generated
      generated: '2026-10-01'
- target: $.paths['/space-permissions/transition/access-removals'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove access for permission combinations
      effect: destructive
      questions:
      - Can I strip all space permissions for certain permission combinations at once?
      - What gets removed when I revoke access for a permission combination?
      instructions:
      - text: Remove access for permission combinations {permissionCombinationIds} in spaces {spaceSelection}.
        slots:
          permissionCombinationIds: requestBody.permissionCombinationIds
          spaceSelection: requestBody.spaceSelection
      - text: Revoke all space permissions held through combinations {permissionCombinationIds} across {spaceSelection}.
        slots:
          permissionCombinationIds: requestBody.permissionCombinationIds
          spaceSelection: requestBody.spaceSelection
      method: generated
      generated: '2026-10-01'
- target: $.paths['/space-permissions/transition/tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a permission transition task's status
      effect: read
      questions:
      - Has my bulk role assignment or access removal finished yet?
      - How can I track progress of a space permission transition job?
      instructions:
      - text: Check the status of permission transition task {taskId}.
        slots:
          taskId: path.taskId
      - text: Tell me whether transition task {taskId} has completed.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'