# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign Rooms API - v2 Documents API
  version: 1.0.0
extends: openapi/docusign-documents-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: 3
- target: $.paths['/v2/accounts/{accountId}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a room document
      effect: read
      questions:
      - How do I fetch a document stored in a room?
      - Can I get a room document's contents in base64?
      instructions:
      - text: Get room document {document} in account {account}.
        slots:
          document: path.documentId
          account: path.accountId
      - text: 'Download room document {document} with contents included: {includeContents}.'
        slots:
          document: path.documentId
          includeContents: query.includeContents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/documents/{documentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a room document
      effect: destructive
      questions:
      - How do I permanently delete a document from a room?
      - Is deleting a room document reversible?
      instructions:
      - text: Delete room document {document} in account {account}.
        slots:
          document: path.documentId
          account: path.accountId
      - text: Permanently remove document {document} from its room.
        slots:
          document: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/documents/{documentId}/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a user access to a room document
      effect: write
      questions:
      - How do I share a room document with another user?
      - Can I give someone access to a single document without the whole room?
      instructions:
      - text: Grant user {userId} access to room document {document} in account {account}.
        slots:
          userId: requestBody.userId
          document: path.documentId
          account: path.accountId
      - text: Share document {document} with user {userId}.
        slots:
          document: path.documentId
          userId: requestBody.userId
      method: generated
      generated: '2026-10-01'