API Evangelist conversational phrasing for Lucid REST Folders Collaboration API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lucid REST Folders Collaboration API
  version: 1.0.0
extends: openapi/lucid-folders-collaboration-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: 11
- target: $.paths['/v1/folders/{id}/shares/users/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one user's direct access to a folder
      effect: read
      questions:
      - What role does a specific person have directly on a Lucid folder?
      - Does a user's inherited folder access show up when I check their collaborator record?
      instructions:
      - text: Show user {userId}'s direct access on folder {id}.
        slots:
          userId: path.userId
          id: path.id
      - text: Get the collaborator role user {userId} holds on folder {id}.
        slots:
          userId: path.userId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/folders/{id}/shares/users/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a folder with a user or change their role
      effect: write
      questions:
      - How do I give a person access to a folder?
      - Can I change the role a user has on a folder I already shared with them?
      instructions:
      - text: Share folder {id} with user {userId} as {role}.
        slots:
          id: path.id
          userId: path.userId
          role: requestBody.role
      - text: Change user {userId}'s role on folder {id} to {role}.
        slots:
          userId: path.userId
          id: path.id
          role: requestBody.role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/folders/{id}/shares/users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user's direct access to a folder
      effect: destructive
      questions:
      - Can I unshare a folder from one person?
      - Will a user still see a folder after I revoke their direct access?
      instructions:
      - text: Revoke user {userId}'s access to folder {id}.
        slots:
          userId: path.userId
          id: path.id
      - text: Stop sharing folder {id} with user {userId}.
        slots:
          id: path.id
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/folders/{id}/shares/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users with direct access to a folder
      effect: read
      questions:
      - Who has been shared directly on a folder?
      - Which people can access this folder without going through a parent folder?
      instructions:
      - text: List the users shared on folder {id}.
        slots:
          id: path.id
      - text: Show every person with direct collaborator access to folder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/folders/{id}/shares/groups/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a group's direct access to a folder
      effect: read
      questions:
      - What role does a particular group have on a folder?
      - Is a group directly shared on a folder or only through a parent?
      instructions:
      - text: Show group {groupId}'s access on folder {id}.
        slots:
          groupId: path.groupId
          id: path.id
      - text: Get the role group {groupId} has on folder {id}.
        slots:
          groupId: path.groupId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/folders/{id}/shares/groups/{groupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a folder with a group or change its role
      effect: write
      questions:
      - How do I grant a whole group access to a folder?
      - Can I change the role a group holds on a folder?
      instructions:
      - text: Share folder {id} with group {groupId} as {role}.
        slots:
          id: path.id
          groupId: path.groupId
          role: requestBody.role
      - text: Set group {groupId}'s role on folder {id} to {role}.
        slots:
          groupId: path.groupId
          id: path.id
          role: requestBody.role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/folders/{id}/shares/groups/{groupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a group's direct access to a folder
      effect: destructive
      questions:
      - Can I take a group off a folder's sharing list?
      - How would I revoke a group's direct folder access?
      instructions:
      - text: Revoke group {groupId}'s access to folder {id}.
        slots:
          groupId: path.groupId
          id: path.id
      - text: Unshare folder {id} from group {groupId}.
        slots:
          id: path.id
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/folders/{id}/shares/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups with direct access to a folder
      effect: read
      questions:
      - Which groups are shared directly on a folder?
      - Can I see all groups that have been granted a folder's access?
      instructions:
      - text: List the groups shared on folder {id}.
        slots:
          id: path.id
      - text: Show all groups with direct access to folder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/folders/{id}/shares/teams/{teamId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a team's access to a folder
      effect: read
      questions:
      - What access does a team have on a given folder?
      - Is a team a collaborator on this folder?
      instructions:
      - text: Show team {teamId}'s collaboration on folder {id}.
        slots:
          teamId: path.teamId
          id: path.id
      - text: Get the role team {teamId} has on folder {id}.
        slots:
          teamId: path.teamId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/folders/{id}/shares/teams/{teamId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a folder with a team or change its role
      effect: write
      questions:
      - Can I add a team as a collaborator on a folder?
      - How do I change the role a team has on a folder?
      instructions:
      - text: Share folder {id} with team {teamId} as {role}.
        slots:
          id: path.id
          teamId: path.teamId
          role: requestBody.role
      - text: Update team {teamId}'s role on folder {id} to {role}.
        slots:
          teamId: path.teamId
          id: path.id
          role: requestBody.role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/folders/{id}/shares/teams/{teamId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a team's direct access to a folder
      effect: destructive
      questions:
      - How can I stop a team from collaborating on a folder?
      - Can I revoke a team's direct access to one folder?
      instructions:
      - text: Revoke team {teamId}'s access to folder {id}.
        slots:
          teamId: path.teamId
          id: path.id
      - text: Remove team {teamId} as a collaborator on folder {id}.
        slots:
          teamId: path.teamId
          id: path.id
      method: generated
      generated: '2026-10-01'