API Evangelist conversational phrasing for Lucid REST Documents Sharing 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 Sharing API
  version: 1.0.0
extends: openapi/lucid-documents-sharing-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: 4
- target: $.paths['/v1/documents/{id}/shares/shareLinks/{shareLinkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document share link
      effect: read
      questions:
      - What settings does an existing share link on a document have?
      - Can I read share links that another app created?
      instructions:
      - text: Get share link {shareLinkId} on document {id}.
        slots:
          shareLinkId: path.shareLinkId
          id: path.id
      - text: Show the role and security of share link {shareLinkId} for document {id}.
        slots:
          shareLinkId: path.shareLinkId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/shares/shareLinks/{shareLinkId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document share link
      effect: destructive
      questions:
      - How do I disable a share link on a document?
      - Which share links am I allowed to delete from my app?
      instructions:
      - text: Delete share link {shareLinkId} on document {id}.
        slots:
          shareLinkId: path.shareLinkId
          id: path.id
      - text: Revoke document {id}'s share link {shareLinkId}.
        slots:
          id: path.id
          shareLinkId: path.shareLinkId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/shares/shareLinks/{shareLinkId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a document share link's settings
      effect: write
      questions:
      - Can I change the role granted by an existing share link?
      - How do I tighten the security on a share link I created?
      instructions:
      - text: Set share link {shareLinkId} on document {id} to role {role}.
        slots:
          shareLinkId: path.shareLinkId
          id: path.id
          role: requestBody.role
      - text: Change link security of share link {shareLinkId} on document {id} to {linkSecurity}.
        slots:
          shareLinkId: path.shareLinkId
          id: path.id
          linkSecurity: requestBody.linkSecurity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/shares/shareLinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a share link for a document
      effect: write
      questions:
      - How do I generate a share link for a Lucid document?
      - Is link security configurable on share links for team accounts?
      instructions:
      - text: Create a {role} share link on document {id} with security {linkSecurity}.
        slots:
          role: requestBody.role
          id: path.id
          linkSecurity: requestBody.linkSecurity
      - text: 'Make a new share link for document {id}: role {role}, security {linkSecurity}.'
        slots:
          id: path.id
          role: requestBody.role
          linkSecurity: requestBody.linkSecurity
      method: generated
      generated: '2026-10-01'