API Evangelist conversational phrasing for Lucid REST Documents 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 Documents Collaboration API
  version: 1.0.0
extends: openapi/lucid-documents-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: 7
- target: $.paths['/v1/documents/{id}/shares/users/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one user's access to a document
      effect: read
      questions:
      - What role does a specific person have on a Lucid document?
      - Can I see the sharing permissions one user was granted on a diagram?
      instructions:
      - text: Show user {userId}'s access on document {id}.
        slots:
          userId: path.userId
          id: path.id
      - text: Get the collaborator role user {userId} has on document {id}.
        slots:
          userId: path.userId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/shares/users/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a document with a user or change their role
      effect: write
      questions:
      - How do I share a document with one person?
      - Can I change someone's role on a document they already have?
      instructions:
      - text: Share document {id} with user {userId} as {role}.
        slots:
          id: path.id
          userId: path.userId
          role: requestBody.role
      - text: Change user {userId}'s role on document {id} to {role}.
        slots:
          userId: path.userId
          id: path.id
          role: requestBody.role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/shares/users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user's access to a document
      effect: destructive
      questions:
      - Can I unshare a document from a particular user?
      - Could a user keep access to a document after I revoke them, through a shared folder?
      instructions:
      - text: Revoke user {userId}'s access to document {id}.
        slots:
          userId: path.userId
          id: path.id
      - text: Stop sharing document {id} with user {userId}.
        slots:
          id: path.id
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/shares/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List the people a document is shared with
      effect: read
      questions:
      - Who are all the collaborators on a document?
      - Can I page through a long list of a document's user collaborators?
      instructions:
      - text: List the collaborators on document {id}.
        slots:
          id: path.id
      - text: Show everyone document {id} is shared with.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/shares/teams/{teamId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a team's access to a document
      effect: read
      questions:
      - What access does a team have on a given document?
      - Is a particular team collaborating on this diagram?
      instructions:
      - text: Show team {teamId}'s access on document {id}.
        slots:
          teamId: path.teamId
          id: path.id
      - text: Get the role team {teamId} holds on document {id}.
        slots:
          teamId: path.teamId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/shares/teams/{teamId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a document with a team or change its role
      effect: write
      questions:
      - How do I add a team as a collaborator on a document?
      - Can I change a team's role on a document?
      instructions:
      - text: Share document {id} with team {teamId} as {role}.
        slots:
          id: path.id
          teamId: path.teamId
          role: requestBody.role
      - text: Set team {teamId}'s role on document {id} to {role}.
        slots:
          teamId: path.teamId
          id: path.id
          role: requestBody.role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/shares/teams/{teamId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a team from a document
      effect: destructive
      questions:
      - Can I take a team off a document's collaborators?
      - Is there a way to revoke a team's access to one document?
      instructions:
      - text: Remove team {teamId} from document {id}.
        slots:
          teamId: path.teamId
          id: path.id
      - text: Revoke team {teamId}'s access to document {id}.
        slots:
          teamId: path.teamId
          id: path.id
      method: generated
      generated: '2026-10-01'