# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign REST Custom Tabs API
  version: 1.0.0
extends: openapi/docusign-custom-tabs-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['/v2/accounts/{accountId}/tab_definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the account's tab definitions
      effect: read
      questions:
      - What custom tabs have been defined on my account?
      - Can I list only custom tabs and skip the standard ones?
      instructions:
      - text: List all tab definitions in account {account}.
        slots:
          account: path.accountId
      - text: Show only the custom tabs on account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/tab_definitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom tab
      effect: write
      questions:
      - How do I create a reusable custom tab with a set font and validation pattern?
      - Can senders reuse a custom tab in the web app after I create it?
      instructions:
      - text: Create a custom tab named {name} of type {type} in account {account}.
        slots:
          name: requestBody.name
          type: requestBody.type
          account: path.accountId
      - text: Add a custom text tab labeled {label} with validation pattern {pattern} to account {account}.
        slots:
          label: requestBody.tabLabel
          pattern: requestBody.validationPattern
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/tab_definitions/{customTabId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom tab
      effect: read
      questions:
      - How can I see the settings of one custom tab?
      - Which properties does a custom tab definition hold?
      instructions:
      - text: Get custom tab {tab} in account {account}.
        slots:
          tab: path.customTabId
          account: path.accountId
      - text: Show the definition of custom tab {tab} on account {account}.
        slots:
          tab: path.customTabId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/tab_definitions/{customTabId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom tab
      effect: write
      questions:
      - Can I change the font or validation of an existing custom tab?
      - How do I rename a custom tab I already created?
      instructions:
      - text: Rename custom tab {tab} in account {account} to {name}.
        slots:
          tab: path.customTabId
          account: path.accountId
          name: requestBody.name
      - text: Set the font size of custom tab {tab} on account {account} to {size}.
        slots:
          tab: path.customTabId
          account: path.accountId
          size: requestBody.fontSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/tab_definitions/{customTabId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom tab
      effect: destructive
      questions:
      - How do I delete a custom tab from my account?
      - Can a custom tab definition be removed once senders have used it?
      instructions:
      - text: Delete custom tab {tab} from account {account}.
        slots:
          tab: path.customTabId
          account: path.accountId
      - text: Remove the custom tab {tab} on account {account}.
        slots:
          tab: path.customTabId
          account: path.accountId
      method: generated
      generated: '2026-10-01'